Creating/Editing Session Facade Artifacts

Creating/Editing Notification Artifacts

General Information

The General Information section contains the following information:

Project: the identifier of the Tigerstripe project where this artifact is defined, as it appears in the Tigerstripe Explorer view. This field cannot be edited. For information on how to move artifacts across projects in the workspace, please visit this section.

Package: the name of the package where the artifact is defined. This field cannot be edited. For more information on how to move artifacts across packages, please refer to this section.

Name: the name of the artifact. This field cannot be edited. For more information on how to rename artifacts, please refer to this section.

Description: a textual description of the artifact. This field can include any HTML code and should document the artifact. It is passed to the corresponding webpage when a project is published to website. For more details on Artifact documentation, please refer to this section.

Extends: the fully qualified name of the super-artifact (ie. the name of the artifact being extended by the current artifact). This is how inheritance is achieved between artifacts. For more information about inheritance within Tigerstripe models, please refer to this section.

Notification Attributes

To edit this Artifact's attributes, expand the Attributes section. The section looks as shown below:

To Add an attribute, press the Add button. A template attribute will be created for this artifact, and the detailed view for this newly created attribute will be presented.

To Remove an attribute, simply select it in the list and press the Remove button. A confirmation dialog for the removal of that artifact will be displayed before the attribute is removed.

To Edit an attribute, select it in the list. The detailed view for this attribute is displayed. It contains the following information that can be edited:

Attribute Name: the name of the attribute. This must be a valid identifier, ie. including no special characters or spaces. This name must be unique within the context of this artifact.

Attribute Type: the fully qualified name of the type for this attribute. To be valid, the type must be:

java.lang.String: this denotes a String attribute. It will be mapped appropriately in the XML and WSDL integration profile to ensure no reference to Java.

Java primitive types: the type will be mapped to the corresponding type in the XML and WSDL integration profile to ensure no reference to Java.

Valid Datatype Artifact type,

Valid Entity Artifact type.

Multiplicity: the multiplicity allows to denote the use of arrays for attributes of type String, of any primitive type, or Datatype Artifact type. When used in combination with an Entity Artifact type, please refer to this section for more information on associations within Tigerstripe Models.

Visibility: defines the visibility of the attribute.

Modifiers: there are two possible modifiers that can be applied to an Attribute:

Optional: an attribute marked as optional means that the implementation may chose to not implement it, but would be compliant with the service contract.

Readonly: an attribute marked as readonly denotes an attribute that can only be read by consumers of the Service Contract.

Reference: when the attribute type is an Entity Artifact type, the attribute can be further specified to qualify the type of reference to the target entity type. Please refer to this section for more information on associations within Tigerstripe models.

Description: a textual description of the attribute. This field shall document the purpose of the attribute. Any HTML code can be placed in to the field as it will be propagated into the web site where the project may be published, as well as in the generated code. For more details on Artifact documentation, please refer to this section.

Notification Constants

To edit this Artifact's constants, expand the Constants section. The section looks as shown below:

To Add a constant, press the Add button. A template constant will be created for this artifact, and the detailed view for this newly created constant will be presented.

To Remove a constant, simply select it in the list and press the Remove button. A confirmation dialog for the removal of that artifact will be displayed before the constant is removed.

To Edit an constant, select it in the list. The detailed view for this constant is displayed. It contains the following information that can be edited:

Constant Name: The name of the constant. This must be a valid identifier (ie. no space or special characters). This identifier must be unique within the context of this Artifact.

Constant Type: The type of constant. Valid constant types are java.lang.String and int. These are mapped into their corresponding type for the XML and WSDL profiles, so no reference to Java appears.

Constant Value: The value for that constant. If select type for this constant is java.lang.String, the given value must be surrounded by ".

Constant Visibility: defines the visibility of this constant.

Constant Description: a textual description of the constant. This field shall document the purpose of the constant. Any HTML code can be placed in to the field as it will be propagated into the web site where the project may be published, as well as in the generated code. For more details on Artifact documentation, please refer to this section.

OSS/J Specifics

The OSS/J Specific Details for this artifact can be specified from the OSS/J Tab of the editor. The following information is available:

Interface Package: the interface package where the corresponding Java interfaces should be generated. This option only applies to the J2EE Integration Profile.

Event Descriptor: the event descriptor is a list of fields that will be available for filtering of the event. Since event filtering can be very resource intensive, this option allows to control at design-time what is to be used for filtering. Event selectors can be specified in one of the following ways:

By selecting an attribute in the event payload: by selecting an attribute present in the event payload, ie. in one of the Notification Artifacts attributes. Please note that only primitive types and Strings can be used for filtering, so the tree view expands and only allows selection of valid attributes.

By setting a custom selector: any custom property that will be added to the header of the event for filtering purpose.