Package com.aquima.interactions.communication.impl

Class RestMessageDefinition

java.lang.Object

com.aquima.interactions.communication.impl.RestMessageDefinition

All Implemented Interfaces:

IRestMessageDefinition

Direct Known Subclasses:

RestRequestMessageDefinition

public class RestMessageDefinition
extends Object
implements IRestMessageDefinition

This class holds the static definition of a rest message.

Since:

9.0

Author:

Arjan Pragt

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestMessageDefinition(RestServiceDefinition serviceDefinition, IRestMessageDS datasource, ICommunicationEngine communicationEngine, IMetaModel metaModel, IRuleEngine ruleEngine)

Method Summary

Modifier and Type	Method	Description
protected void	addHeader(RestHeaderDefinition header)
String	getBodyAttributeName()	This method returns the content attribute of the message.
IElementReference	getBodyElement()	This method returns reference to the body element.
IDomainSchemaDefinition	getBodySchema()	This method returns the domain schema in case of a domain schema service.
protected IEntityDefinition	getEntity()
String	getEntityName()	This method returns the entity connecting to the message.
IRestHeaderDefinition[]	getHeaders()	This method returns the headers of the message.
IFieldValidationDefinition[]	getValidations()	This method returns the validations of the attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RestMessageDefinition

protected RestMessageDefinition(RestServiceDefinition serviceDefinition,
 IRestMessageDS datasource,
 ICommunicationEngine communicationEngine,
 IMetaModel metaModel,
 IRuleEngine ruleEngine)

Method Details

getEntityName

public String getEntityName()

Description copied from interface: IRestMessageDefinition

This method returns the entity connecting to the message.

Specified by:

getEntityName in interface IRestMessageDefinition

Returns:

The entity, may not be null.

getEntity

protected IEntityDefinition getEntity()

getHeaders

public IRestHeaderDefinition[] getHeaders()

Description copied from interface: IRestMessageDefinition

This method returns the headers of the message.

Specified by:

getHeaders in interface IRestMessageDefinition

Returns:

The headers of the message, may not be null.

getBodyElement

public IElementReference getBodyElement()

Description copied from interface: IRestMessageDefinition

This method returns reference to the body element. If may return null if the message does not contain a body, or if the service uses domain schemas.

Specified by:

getBodyElement in interface IRestMessageDefinition

Returns:

The full qualifiedname of the element of the body, may be null.

getBodySchema

public IDomainSchemaDefinition getBodySchema()

Description copied from interface: IRestMessageDefinition

This method returns the domain schema in case of a domain schema service. If may return null if the message does not contain a body, or if the service does not domain schemas.

Specified by:

getBodySchema in interface IRestMessageDefinition

Returns:

The domain schema in case of a domain schema service, may be null.

getBodyAttributeName

public String getBodyAttributeName()

Description copied from interface: IRestMessageDefinition

This method returns the content attribute of the message.

Specified by:

getBodyAttributeName in interface IRestMessageDefinition

Returns:

The body attribute, may be null.

addHeader

protected void addHeader(RestHeaderDefinition header)

getValidations

public IFieldValidationDefinition[] getValidations()

Description copied from interface: IRestMessageDefinition

This method returns the validations of the attribute.

Specified by:

getValidations in interface IRestMessageDefinition

Returns:

The validations of the attribute, may not be null.