liferay-service-builder_7_4_0.dtd: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES

liferay-service-builder_7_4_0.dtd

<!DOCTYPE service-builder PUBLIC "-//Liferay//DTD Service Builder 7.4.0//EN" "http://www.liferay.com/dtd/liferay-service-builder_7_4_0.dtd">

The service-builder element is the root of the deployment descriptor for a Service Builder descriptor that is used to generate services available to portlets. The Service Builder saves the developer time by generating Spring utilities, SOAP utilities, and Hibernate persistence classes to ease the development of services.

<service-builder>'s children Name Cardinality author One or none entity Any number exceptions One or none namespace Only one service-builder-import Any number

<service-builder>'s attributes Name Values Default auto-import-default-references auto-namespace-tables change-tracking-enabled dependency-injector mvcc-enabled package-path short-no-such-exception-enabled

(author?, namespace, entity*, exceptions?, service-builder-import*)

The package-path value specifies the package of the generated code.

Required

The auto-import-default-references value specifies whether or not to automatically default references. The default value is true.

The auto-namespace-tables value specifies whether or not to automatically namespace tables. The default value is false for core services and true for plugin services.

The change-tracking-enabled value specifies whether or not to enable change tracking by default for entities. Change tracking is a publishing framework that intercepts changes to data in entities' generated PersistenceImpl classes and queries made through Hibernate. It is highly encouraged to enable change tracking in the service-builder element instead of per entity. MVCC must be enabled to enable change tracking. The default value is false.

The dependency-injector value specifies which dependency injector to use. Valid values are "spring" and "ds". For new OSGi modules, the default value is "ds", for existing modules or WARs, the default value is "spring".

The mvcc-enabled value specifies whether or not to enable MVCC by default for entities to prevent lost updates. The default value is false.

The short-no-such-exception-enabled value specifies whether to try to shorten the no such exception class names when possible.

For example, if set to to true, generate the class NoSuchEntryException when the entity name is BlogsEntry and the namespace is Blogs. If set to false, generate the class NoSuchBlogsEntryException.

The default value is true.

The author element is the name of the user associated with the generated code.

The namespace element must be a unique namespace for this component. Table names will be prepended with this namespace. Generated JSON JavaScript will be scoped to this namespace as well (i.e., Liferay.Service.Test.* if the namespace is Test).

An entity usually represents a business facade and a table in the database. If an entity does not have any columns, then it only represents a business facade. The Service Builder will always generate an empty business facade POJO if it does not exist. Upon subsequent generations, the Service Builder will check to see if the business facade already exists. If it exists and has additional methods, then the Service Builder will also update the SOAP wrappers.

If an entity does have columns, then the value object, the POJO class that is mapped to the database, and other persistence utilities are also generated based on the order and finder elements.

<entity>'s children Name Cardinality column Any number finder Any number localized-entity One or none order One or none reference Any number tx-required Any number

<entity>'s attributes Name Values Default cache-enabled change-tracking-enabled data-source deprecated dynamic-update-enabled external-reference-code human-name json-enabled local-service mvcc-enabled name persistence persistence-class plural-name plural-variable-name remote-service session-factory table trash-enabled tx-manager uad-application-name uad-auto-delete uad-dir-path uad-package-path uuid uuid-accessor variable-name versioned

(column*, localized-entity?, order?, finder*, reference*, tx-required*)

The name value specifies the name of the entity.

Required

The variable-name value specifies the variable name of the name. If none is specified, one will be generated from the name.

The plural-name value specifies the plural form of the name. If none is specified, one will be generated from the name.

The plural-variable-name value specifies the plural form of the variable name. If none is specified, one will be generated from the variable name.

The human-name value specifies the readable name to use when generating documentation for this entity. If none is specified, one will be generated from the name.

The table value specifies the name of the table that this entity maps to in the database. If this value is not set, then the name of the table is the same as the name of the entity.

If the uuid value is true, then the service will generate a UUID column for the service. This column will automatically be populated with a UUID. Developers will also be able to find and remove based on that UUID. The default value is false.

If the uuid-accessor value is true, then the service will generate a UUID column accessor for the service. This accessor will provide a fast and type-safe way to access entity's UUID.

The external-reference-code value specifies if the service will generate an external reference code column for the service. The possible values are "none", "company", and "group". The default value is "none" and no external reference code column will be generated. The value "company" will generate an external reference code column scoped by company. The value "group" will generate an external reference code column scoped by group.

The deprecated value "true" maps to "company" and the deprecated "false" maps to "none".

If the local-service value is true, then the service will generate the local interfaces for the service. The default value is false.

If the remote-service value is true, then the service will generate remote interfaces for the service. The default value is true.

If the persistence value is true, then the service will generate persistence interfaces and database files for the service. The default value is true.

The persistence-class value specifies the name of your custom persistence class. This class must implement the generated persistence interface or extend the generated persistence class. This allows you to override default behavior without modifying the generated persistence class.

The data-source value specifies the data source target that is set to the persistence class. The default value is the Liferay data source. This is used in conjunction with session-factory. See data-source-spring.xml.

You can generate classes to use a custom data source and session factory. Point "spring.configs" in portal.properties to load your custom Spring XML with the definitions of your custom data source and session factory. Then set the data-source and session-factory values to your custom values.

The session-factory value specifies the session factory that is set to the persistence class. The default value is the Liferay session factory. This is used in conjunction with data-source. See data-source-spring.xml.

You can generate classes to use a custom data source and session factory. Point "spring.configs" in portal.properties to load your custom Spring XML with the definitions of your custom data source and session factory. Then set the data-source and session-factory values to your custom values.

The tx-manager value specifies the transaction manager that Spring uses. The default value is the Spring Hibernate transaction manager that wraps the Liferay data source and session factory. See data-source-spring.xml. Set this attribute to "none" to disable transaction management.

The cache-enabled value specifies whether or not to cache this queries for this entity. Set this to false if data in the table will be updated by other programs. The default value is true.

The change-tracking-enabled value specifies whether or not to enable change tracking for this entity. Change tracking is a publishing framework that intercepts changes to data in the entity's generated PersistenceImpl class and queries made through Hibernate. It is highly encouraged to enable change tracking in the service-builder element instead of per entity. MVCC must be enabled to enable change tracking.

The dynamic-update-enabled value specifies whether or not unmodified properties are excluded in the SQL update statement. The default value is the value of the attribute mvcc-enabled.

The json-enabled value specifies whether or not the entity should be annotated for JSON serialization. By default, if the remote-service value is true, then the json-enabled value is true.

The mvcc-enabled value specifies whether or not to enable MVCC for this entity to prevent lost updates. The default value is based on the mvcc-enabled attribute in the service-builder element.

The trash-enabled value specifies whether trash related methods should be generated or not.

The uad-application-name value specifies the name of the application that the entity type belongs to in the GDPR UI.

The uad-auto-delete value specifies whether or not the entity should be automatically deleted during the auto-anonymization.

The uad-dir-path value specifies the directory path of the generated UAD implementations.

The uad-package-path value specifies the package path for the generated UAD classes.

If the versioned value is true, then the service will generate a version table, columns, and methods to version the entity.

The deprecated value specifies whether the entity's services are deprecated.

The column element represents a column in the database.

<column>'s attributes Name Values Default accessor change-tracking-resolution-type container-model convert-null db-name entity filter-primary id-param id-type json-enabled lazy localized mapping-table method-name name parent-container-model plural-name primary type uad-anonymize-field-name uad-nonanonymizable

The name value specifies the getter and setter name in the entity.

Required

The plural-name value specifies the plural form of the column name. If none is specified, one will be generated from the column name.

Set db-name to map the field to a physical database column that is different from the column name.

The method-name value is used to override the default getter/setter method names.

For example:

<column method-name="FOOBar" name="fooBar" type="String" />

The above column specifies that there will be a getter called pojo.getFOOBar() instead of the default pojo.getFooBar().

The type value specifies whether the column is a String, Boolean, or int, etc.

For example:

<column db-name="companyId" name="companyId" type="String" />

The above column specifies that there will be a getter called pojo.getCompanyId() that will return a String.

Required

If the primary value is set to true, then this column is part of the primary key of the entity. If multiple columns have the primary value set to true, then a compound key will be created.

This accessor value specifies whether or not to generate an accessor for this column. This accessor will provide a fast and type-safe way to access column value.

The filter-primary value specifies the column to use as the primary key column when using filter finders. Only one column should ever have this value set to true. If no column has this set to true, then the default primary column will be used.

If the entity and mapping-table attributes are specified, then the Service Builder will assume you are specifying a many to many relationship.

For example:

<column name="roles" type="Collection" entity="Role" mapping-table="Groups_Roles" />

The above column specifies that there will be a getter called pojo.getRoles() that will return a collection. It will use a mapping table called Groups_Roles to give a many to many relationship between groups and roles.

If you are creating a mapping table for an entity defined in another service.xml, you need to specify the full package path.

For example:

<column name="organizations" type="Collection" entity="com.liferay.portal.Organization" mapping-table="Foo_Organizations" />

See the entity attribute's description for more information.

The id-type and id-param values are used in order to create an auto-generated, auto-incrementing primary key when inserting records into a table. This can be implemented in 4 different ways, depending on the type of database being used. In all cases, the primary key of the model object should be assigned a value of null, and Hibernate will know to replace the null value with an auto-generated, auto-incremented value. If no id-type value is used, it is assumed that the primary key will be assigned and not auto-generated.

The first implementation uses a class to generate a primary key.

For example:

<column name="id" type="Integer" primary="true" id-type="class" id-param="com.liferay.counter.service.persistence.IDGenerator" />

In this implementation, the class specified in the id-param value will be called to retrieve a unique identifier (in the example above, an Integer) that will be used as the primary key for the new record. This implementation works for all supported databases.

The second implementation generates identifiers that are unique only when no other process is inserting data into the same table. This implementation should NOT be used in a clustered environment, but it does work for all supported databases.

For example:

<column name="id" type="Integer" primary="true" id-type="increment" />

The third implementation uses an identity column to generate a primary key.

For example:

<column name="id" type="Integer" primary="true" id-type="identity" />

In this implementation, the create table SQL generated for this entity will create an identity column that natively auto-generates a primary key whenever an insert occurs. This implementation is only supported by DB2, MySQL, and MS SQL Server.

The fourth implementation uses a sequence to generate a primary key.

For example:

<column name="id" type="Integer" primary="true" id-type="sequence" id-param="id_sequence" />

In this implementation, a create sequence SQL statement is created based on the id-param value (stored in /sql/sequences.sql). This sequence is then accessed to generate a unique identifier whenever an insert occurs. This implementation is only supported by DB2, Oracle, PostgreSQL, and SAP DB.

See the id-type attribute's description for more information.

The change-tracking-resolution-type value specifies how to resolve columns when a modification conflict is detected when publishing. This value is only used when change tracking is enabled for the entity. Some values are automatically determined by column. Otherwise, the default value is STRICT.

See com.liferay.portal.kernel.change.tracking.CTColumnResolutionType for available options.

The convert-null value specifies whether or not the column value is automatically converted to a non null value if it is null. This only applies if the type value is String. This is particularly useful if your entity is referencing a read only table or a database view so that Hibernate does not try to issue unnecessary updates. The default value is true.

The lazy value is only valid when type is Blob. It specifies whether or not to do a lazy fetch for Blob. The default value is true.

The localized value specifies whether or not the value of the column can have different values for different locales. The default value is false. Localization can also be performed by using a generated localization table using the localized-entity and localized-column elements. The localized value cannot be set to true when the entity contains a localized-entity element. Using the localized-entity element with a separate table is recommended.

The json-enabled value specifies whether or not the column should be annotated for JSON serialization. By default, if the json-enabled value in the entity element is true, then the json-enabled value in the column element is true.

The container-model value specifies whether the column represents the primary key of a container model.

The parent-container-model value specifies whether the column represents the primary key of a parent container model.

The uad-anonymize-field-name value specifies the anonymous user field that should be used to replace this column's value during auto anonymization. For example, if "fullName" is specified, the anonymous user's full name will replace this column's value during auto anonymization. The uad-anonymize-field-name value should only be used with user name columns (e.g. "statusByUserName").

The uad-nonanonymizable value specifies whether the column represents data associated with a specific user that should be reviewed by an administrator in the event of a GDPR compliance request. This implies the data cannot be anonymized automatically.

The localized-entity element represents a table with a one to many mapping from the entity table to the localized entity table. The localized entity table is designed to be used instead of setting a column element's localized attribute to true. A defaultLanguageId column is generated for the entity table and several columns, finders, and update methods are generated for the localized entity.

<localized-entity>'s children Name Cardinality column Any number finder Any number localized-column At least one order One or none

<localized-entity>'s attributes Name Values Default name table

(column*, localized-column+, order?, finder*)

The name value specifies the name of the localized entity. If this value is not set, then the parent entity's name is used with "Localization" appended.

The table value specifies the name of the table that this localized entity maps to in the database. If this value is not set, then the name of the table is the same as the name of the localized entity.

The localized-column element represents a column in the localization table.

<localized-column>'s attributes Name Values Default db-name name

The name value specifies the getter and setter name in the entity and localization entity.

Required

Set db-name to map the field to a physical database column that is different from the localized-column name.

The order element specifies a default ordering and sorting of the entities when they are retrieved from the database.

<order>'s children Name Cardinality order-column At least one

<order>'s attributes Name Values Default by

(order-column+)

Set the by attribute to "asc" or "desc" to order by ascending or descending.

The order-column element allows you to order the entities by specific columns.

The attributes of the order-column element allows you to fine tune the ordering of the entity.

For example:

<order by="asc"> <order-column name="parentLayoutId" /> <order-column name="priority" /> </order>

The above settings will order by parentLayoutId and then by priority in an ascending manner.

For example:

<order by="asc"> <order-column name="name" case-sensitive="false" /> </order>

The above settings will order by name and will not be case sensitive.

For example:

<order> <order-column name="articleId" order-by="asc" /> <order-column name="version" order-by="desc" /> </order>

The above settings will order by articleId in an ascending manner and then by version in a descending manner.

<order-column>'s attributes Name Values Default case-sensitive name order-by

The name value specifies the name of the entity.

Required

The case-sensitive value specifies whether or not the name is case sensitive. The default value is true.

The order-by value specifies how to order the entity names. Possible values for this attribute are "asc" (ascending) or "desc" (descending).

The finder element represents a generated finder method.

<finder>'s children Name Cardinality finder-column At least one

<finder>'s attributes Name Values Default db-index name plural-name return-type unique where

(finder-column+)

The name value specifies the name of the finder method.

Required

The plural-name value specifies the plural form of the finder name. If none is specified, one will be generated from the finder name.

The return-type value specifies the return type of the finder. Valid values are "Collection" or the name of the entity. If the value is "Collection", then this finder returns a list of entities. If the value is the name of the entity, then this finder returns at most one entity.

Required

If the unique value is true, then the finder must return a unique entity.

Sorry, no documentation.

If the db-index value is true, then the service will automatically generate a SQL index for this finder. The default value is true.

The finder-column element specifies the columns to find by.

<finder-column>'s attributes Name Values Default arrayable-operator arrayable-pagination case-sensitive comparator name

The name value specifies the name of the finder method.

For example:

<finder name="CompanyId" return-type="Collection"> <finder-column name="companyId" /> </finder>

The above settings will create a finder with the name findByCompanyId that will return a Collection and require a given companyId. It will also generate several more findByCompanyId methods that take in pagination fields (int begin, int end) and more sorting options. The easiest way to understand this is to look at a generated PersistenceImpl class. The Service Builder will also generate removeByCompanyId and countByCompanyId.

See com.liferay.portal.service.persistence.impl.LayoutPersistenceImpl for a good example.

Required

The attribute case-sensitive is a boolean value and is only used if the column is a String value.

The attribute comparator takes in the values =, !=, <, <=, >, >=, or LIKE and is used to compare this column.

The attribute arrayable-operator takes in the values AND or OR and will generate an additional finder where this column's parameter takes an array instead of a single value. Every value in this array will be compared with the column using the comparator, and the conditions will be combined with either an AND or OR operator. For example, a finder column with the = comparator and an arrayable-operator of OR will act like an IN clause.

The attribute arrayable-pagination is a boolean value and is used to signal if the entity column can be paginated.

The reference element allows you to inject services from another service.xml within the same class loader. For example, if you inject the Resource entity, then you'll be able to reference the Resource services from your service implementation via the methods getResourceLocalService and getResourceService. You'll also be able to reference the Resource services via the variables resourceLocalService and resourceService.

<reference>'s attributes Name Values Default entity package-path

See the comments in reference element.

See the comments in reference element.

The tx-required element has a text value that will be used to match method names that require transactions. By default, the methods: add*, check*, clear*, delete*, set*, and update* require propagation of transactions. All other methods support transactions but are assumed to be read only. If you want additional methods to fall under transactions, add the method name to this element.

The tx-required attribute is deprecated in favor annotating the service impl method with com.liferay.portal.kernel.transaction.Transactional.

The exceptions element contain a list of generated exceptions. This doesn't save a lot of typing, but can still be helpful.

<exceptions>'s children Name Cardinality exception Any number

(exception*)

See the comments in exceptions element.

The service-builder-import allows you to split up a large Service Builder file into smaller files by aggregrating the smaller Service Builder into one file. Note that there can be at most one author element among all the files. There can also only be one and only one namespace element among all the files.

The attribute file is interpreted as relative to the file that is importing it.

<service-builder-import>'s attributes Name Values Default file

Set the comments in the service-builder-import element.

Required