Package com.aquima.interactions.communication.impl

Class RestServiceDefinition

java.lang.Object

com.aquima.interactions.communication.impl.RestServiceDefinition

All Implemented Interfaces:

IRestServiceDefinition

public final class RestServiceDefinition
extends Object
implements IRestServiceDefinition

This class holds the static definition of a rest service.

Since:

9.0

Author:

Arjan Pragt

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestServiceDefinition(IRestServiceDS datasource, CommunicationEngine engine, IMetaModel metamodel, IRuleEngine ruleEngine)

Method Summary

Modifier and Type	Method	Description
protected void	addOperation(RestOperationDefinition def)
String	getLocation()	Returns the location url of the service.
String	getName()	Returns the name of the service.
IRestOperationDefinition	getOperation(String operationName)	Returns an operation of the service.
String[]	getOperationNames()	Returns all available operation names in the service.
ISchemaSetDefinition	getSchemaSet()	Returns the corresponding schemaset of the service.
boolean	useDomainSchemas()	Returns a indicator whether to use domain schemas (otherwise schemasets are used).

Methods inherited from class java.lang.Object

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

Constructor Details

RestServiceDefinition

protected RestServiceDefinition(IRestServiceDS datasource,
 CommunicationEngine engine,
 IMetaModel metamodel,
 IRuleEngine ruleEngine)
                         throws InitializationException

Throws:

InitializationException

Method Details

getName

public String getName()

Description copied from interface: IRestServiceDefinition

Returns the name of the service.

Specified by:

getName in interface IRestServiceDefinition

Returns:

The name of the service, may not be null.

getLocation

public String getLocation()

Description copied from interface: IRestServiceDefinition

Returns the location url of the service.

Specified by:

getLocation in interface IRestServiceDefinition

Returns:

The location url of the service, may be null.

getSchemaSet

public ISchemaSetDefinition getSchemaSet()

Description copied from interface: IRestServiceDefinition

Returns the corresponding schemaset of the service.

Specified by:

getSchemaSet in interface IRestServiceDefinition

Returns:

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

useDomainSchemas

public boolean useDomainSchemas()

Description copied from interface: IRestServiceDefinition

Returns a indicator whether to use domain schemas (otherwise schemasets are used).

Specified by:

useDomainSchemas in interface IRestServiceDefinition

Returns:

Indicator for using domain schemas.

getOperation

public IRestOperationDefinition getOperation(String operationName)
                                      throws UnknownOperationException

Description copied from interface: IRestServiceDefinition

Returns an operation of the service.

Specified by:

getOperation in interface IRestServiceDefinition

Parameters:

operationName - The name of the operation, may not be null.

Returns:

The definition of the operation.

Throws:

UnknownOperationException - when the operation does not exists for the rest service.

getOperationNames

public String[] getOperationNames()

Description copied from interface: IRestServiceDefinition

Returns all available operation names in the service.

Specified by:

getOperationNames in interface IRestServiceDefinition

Returns:

The operation names of the service, may not be null.

addOperation

protected void addOperation(RestOperationDefinition def)
                     throws InitializationException

Throws:

InitializationException