toolbox.services.util.header.beans
Class ServiceHeader

java.lang.Object
  toolbox.services.util.header.beans.ServiceHeader

All Implemented Interfaces:

java.io.Serializable, DaoBean

public class ServiceHeader
extends java.lang.Object
implements DaoBean, java.io.Serializable

An attempt to define a general header structure for service implementations.

ServiceHeader bean generated by the Toolbox Bean Generator.

This bean implements the DaoBean interface that allows it to be persisted by sub-class instances of the toolbox.services.dao.DaoService class.

See Also:

Serialized Form

Constructor Summary

ServiceHeader()
Default constructor to initialise the internal Map for storing bean properties.

Method Summary

static ServiceHeader	create(java.util.Map map) Create a new ServiceHeader bean instance using the properties in the given Map as the values of the bean properties.
java.lang.String	getCommonEntityKey() Return the commonEntityKey property.
java.lang.String	getCorrelationId() Return the correlationId property.
java.util.Date	getCreationTime() Return the creationTime property.
java.lang.String	getDocumentId() Return the documentId property.
java.util.Map	getMap() Return the Map containing the bean properties.
java.lang.String	getMapping(java.lang.String prop) Return the mapped value for the provided property name.
java.util.Map	getMappings() Return the Map containing the property mappings.
java.lang.String	getReferenceId() Return the referenceId property.
java.lang.String	getReferenceParameter1() Return the referenceParameter1 property.
java.lang.String	getReferenceParameter2() Return the referenceParameter2 property.
java.lang.String	getReferenceParameter3() Return the referenceParameter3 property.
java.lang.String	getReferenceParameter4() Return the referenceParameter4 property.
java.lang.String	getReferenceParameter5() Return the referenceParameter5 property.
java.lang.String	getRelease() Return the release property.
java.lang.String	getServiceInterface() Return the serviceInterface property.
java.lang.String	getServiceOperation() Return the serviceOperation property.
java.lang.String	getSourceEntityKey() Return the sourceEntityKey property.
java.lang.String	getSourceInterface() Return the sourceInterface property.
java.lang.String	getSourceOperation() Return the sourceOperation property.
java.lang.String	getSourceSystem() Return the sourceSystem property.
java.lang.String	getSystemEnvironment() Return the systemEnvironment property.
java.lang.String	getTargetEntityKey() Return the targetEntityKey property.
java.lang.String	getTargetInterface() Return the targetInterface property.
java.lang.String	getTargetOperation() Return the targetOperation property.
java.lang.String	getTargetRelease() Return the targetRelease property.
java.lang.String	getTargetSystem() Return the targetSystem property.
java.lang.String	getVersion() Return the version property.
void	setCommonEntityKey(java.lang.String commonEntityKey) Set the commonEntityKey property.
void	setCorrelationId(java.lang.String correlationId) Set the correlationId property.
void	setCreationTime(java.util.Date creationTime) Set the creationTime property.
void	setDocumentId(java.lang.String documentId) Set the documentId property.
void	setMap(java.util.Map map) Set the Map containing the bean properties.
void	setReferenceId(java.lang.String referenceId) Set the referenceId property.
void	setReferenceParameter1(java.lang.String referenceParameter1) Set the referenceParameter1 property.
void	setReferenceParameter2(java.lang.String referenceParameter2) Set the referenceParameter2 property.
void	setReferenceParameter3(java.lang.String referenceParameter3) Set the referenceParameter3 property.
void	setReferenceParameter4(java.lang.String referenceParameter4) Set the referenceParameter4 property.
void	setReferenceParameter5(java.lang.String referenceParameter5) Set the referenceParameter5 property.
void	setRelease(java.lang.String release) Set the release property.
void	setServiceInterface(java.lang.String serviceInterface) Set the serviceInterface property.
void	setServiceOperation(java.lang.String serviceOperation) Set the serviceOperation property.
void	setSourceEntityKey(java.lang.String sourceEntityKey) Set the sourceEntityKey property.
void	setSourceInterface(java.lang.String sourceInterface) Set the sourceInterface property.
void	setSourceOperation(java.lang.String sourceOperation) Set the sourceOperation property.
void	setSourceSystem(java.lang.String sourceSystem) Set the sourceSystem property.
void	setSystemEnvironment(java.lang.String systemEnvironment) Set the systemEnvironment property.
void	setTargetEntityKey(java.lang.String targetEntityKey) Set the targetEntityKey property.
void	setTargetInterface(java.lang.String targetInterface) Set the targetInterface property.
void	setTargetOperation(java.lang.String targetOperation) Set the targetOperation property.
void	setTargetRelease(java.lang.String targetRelease) Set the targetRelease property.
void	setTargetSystem(java.lang.String targetSystem) Set the targetSystem property.
void	setVersion(java.lang.String version) Set the version property.
java.lang.String	toString() Return a String representation of this DaoBean instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceHeader

public ServiceHeader()

Default constructor to initialise the internal Map for storing bean properties.

Method Detail

setSourceSystem

public void setSourceSystem(java.lang.String sourceSystem)

Set the sourceSystem property.

The source system where the service call originated from

Parameters:

sourceSystem - New value of the sourceSystem property.

getSourceSystem

public java.lang.String getSourceSystem()

Return the sourceSystem property.

The source system where the service call originated from

Returns:

String containinig the value of the sourceSystem property.

setSourceInterface

public void setSourceInterface(java.lang.String sourceInterface)

Set the sourceInterface property.

The interface (or component) on the source system.

Parameters:

sourceInterface - New value of the sourceInterface property.

getSourceInterface

public java.lang.String getSourceInterface()

Return the sourceInterface property.

The interface (or component) on the source system.

Returns:

String containinig the value of the sourceInterface property.

setSourceOperation

public void setSourceOperation(java.lang.String sourceOperation)

Set the sourceOperation property.

The operation on the source interface (or component) that generated the service call.

Parameters:

sourceOperation - New value of the sourceOperation property.

getSourceOperation

public java.lang.String getSourceOperation()

Return the sourceOperation property.

The operation on the source interface (or component) that generated the service call.

Returns:

String containinig the value of the sourceOperation property.

setSourceEntityKey

public void setSourceEntityKey(java.lang.String sourceEntityKey)

Set the sourceEntityKey property.

The primary key of the entity on the source system. This can help to facilitate cross referencing.

Parameters:

sourceEntityKey - New value of the sourceEntityKey property.

getSourceEntityKey

public java.lang.String getSourceEntityKey()

Return the sourceEntityKey property.

The primary key of the entity on the source system. This can help to facilitate cross referencing.

Returns:

String containinig the value of the sourceEntityKey property.

setServiceInterface

public void setServiceInterface(java.lang.String serviceInterface)

Set the serviceInterface property.

The name of an intermediary that represents a source and target agnostic integration interface. This can help to facilitate cross referencing.

Parameters:

serviceInterface - New value of the serviceInterface property.

getServiceInterface

public java.lang.String getServiceInterface()

Return the serviceInterface property.

The name of an intermediary that represents a source and target agnostic integration interface. This can help to facilitate cross referencing.

Returns:

String containinig the value of the serviceInterface property.

setServiceOperation

public void setServiceOperation(java.lang.String serviceOperation)

Set the serviceOperation property.

The operation invoked on the serviceInterface.

Parameters:

serviceOperation - New value of the serviceOperation property.

getServiceOperation

public java.lang.String getServiceOperation()

Return the serviceOperation property.

The operation invoked on the serviceInterface.

Returns:

String containinig the value of the serviceOperation property.

setTargetSystem

public void setTargetSystem(java.lang.String targetSystem)

Set the targetSystem property.

The target system that must be invoked.

Parameters:

targetSystem - New value of the targetSystem property.

getTargetSystem

public java.lang.String getTargetSystem()

Return the targetSystem property.

The target system that must be invoked.

Returns:

String containinig the value of the targetSystem property.

setTargetInterface

public void setTargetInterface(java.lang.String targetInterface)

Set the targetInterface property.

The interface on the target system that must be invoked.

Parameters:

targetInterface - New value of the targetInterface property.

getTargetInterface

public java.lang.String getTargetInterface()

Return the targetInterface property.

The interface on the target system that must be invoked.

Returns:

String containinig the value of the targetInterface property.

setTargetOperation

public void setTargetOperation(java.lang.String targetOperation)

Set the targetOperation property.

The operation on the target interface that must be invoked.

Parameters:

targetOperation - New value of the targetOperation property.

getTargetOperation

public java.lang.String getTargetOperation()

Return the targetOperation property.

The operation on the target interface that must be invoked.

Returns:

String containinig the value of the targetOperation property.

setTargetEntityKey

public void setTargetEntityKey(java.lang.String targetEntityKey)

Set the targetEntityKey property.

The primary key of the entity on the target system. This can help to facilitate cross referencing.

Parameters:

targetEntityKey - New value of the targetEntityKey property.

getTargetEntityKey

public java.lang.String getTargetEntityKey()

Return the targetEntityKey property.

The primary key of the entity on the target system. This can help to facilitate cross referencing.

Returns:

String containinig the value of the targetEntityKey property.

setTargetRelease

public void setTargetRelease(java.lang.String targetRelease)

Set the targetRelease property.

The release of the target interface that must be invoked.

Parameters:

targetRelease - New value of the targetRelease property.

getTargetRelease

public java.lang.String getTargetRelease()

Return the targetRelease property.

The release of the target interface that must be invoked.

Returns:

String containinig the value of the targetRelease property.

setCommonEntityKey

public void setCommonEntityKey(java.lang.String commonEntityKey)

Set the commonEntityKey property.

A common key that can be used to identify an entity in an application agnostic manner. This can help to facilitate cross referencing.

Parameters:

commonEntityKey - New value of the commonEntityKey property.

getCommonEntityKey

public java.lang.String getCommonEntityKey()

Return the commonEntityKey property.

A common key that can be used to identify an entity in an application agnostic manner. This can help to facilitate cross referencing.

Returns:

String containinig the value of the commonEntityKey property.

setReferenceId

public void setReferenceId(java.lang.String referenceId)

Set the referenceId property.

A unique ID provided by the client that generated the service call. This ID can help the client to track the message.

Parameters:

referenceId - New value of the referenceId property.

getReferenceId

public java.lang.String getReferenceId()

Return the referenceId property.

A unique ID provided by the client that generated the service call. This ID can help the client to track the message.

Returns:

String containinig the value of the referenceId property.

setReferenceParameter1

public void setReferenceParameter1(java.lang.String referenceParameter1)

Set the referenceParameter1 property.

Optional reference parameter 1. This can help the client to track the message.

Parameters:

referenceParameter1 - New value of the referenceParameter1 property.

getReferenceParameter1

public java.lang.String getReferenceParameter1()

Return the referenceParameter1 property.

Optional reference parameter 1. This can help the client to track the message.

Returns:

String containinig the value of the referenceParameter1 property.

setReferenceParameter2

public void setReferenceParameter2(java.lang.String referenceParameter2)

Set the referenceParameter2 property.

Optional reference parameter 2. This can help the client to track the message.

Parameters:

referenceParameter2 - New value of the referenceParameter2 property.

getReferenceParameter2

public java.lang.String getReferenceParameter2()

Return the referenceParameter2 property.

Optional reference parameter 2. This can help the client to track the message.

Returns:

String containinig the value of the referenceParameter2 property.

setReferenceParameter3

public void setReferenceParameter3(java.lang.String referenceParameter3)

Set the referenceParameter3 property.

Optional reference parameter 3. This can help the client to track the message.

Parameters:

referenceParameter3 - New value of the referenceParameter3 property.

getReferenceParameter3

public java.lang.String getReferenceParameter3()

Return the referenceParameter3 property.

Optional reference parameter 3. This can help the client to track the message.

Returns:

String containinig the value of the referenceParameter3 property.

setReferenceParameter4

public void setReferenceParameter4(java.lang.String referenceParameter4)

Set the referenceParameter4 property.

Optional reference parameter 4. This can help the client to track the message.

Parameters:

referenceParameter4 - New value of the referenceParameter4 property.

getReferenceParameter4

public java.lang.String getReferenceParameter4()

Return the referenceParameter4 property.

Optional reference parameter 4. This can help the client to track the message.

Returns:

String containinig the value of the referenceParameter4 property.

setReferenceParameter5

public void setReferenceParameter5(java.lang.String referenceParameter5)

Set the referenceParameter5 property.

Optional reference parameter 5. This can help the client to track the message.

Parameters:

referenceParameter5 - New value of the referenceParameter5 property.

getReferenceParameter5

public java.lang.String getReferenceParameter5()

Return the referenceParameter5 property.

Optional reference parameter 5. This can help the client to track the message.

Returns:

String containinig the value of the referenceParameter5 property.

setDocumentId

public void setDocumentId(java.lang.String documentId)

Set the documentId property.

A unique ID to identify this document across distributed systems. This ID is generated when the service call enters the service infrastructure and stays with the payload document until processing completes.

Parameters:

documentId - New value of the documentId property.

getDocumentId

public java.lang.String getDocumentId()

Return the documentId property.

A unique ID to identify this document across distributed systems. This ID is generated when the service call enters the service infrastructure and stays with the payload document until processing completes.

Returns:

String containinig the value of the documentId property.

setCorrelationId

public void setCorrelationId(java.lang.String correlationId)

Set the correlationId property.

The documentId of a previously received message. This will enable the sender of the original (asynchronous) message to correlate asynchronous interactions.

Parameters:

correlationId - New value of the correlationId property.

getCorrelationId

public java.lang.String getCorrelationId()

Return the correlationId property.

The documentId of a previously received message. This will enable the sender of the original (asynchronous) message to correlate asynchronous interactions.

Returns:

String containinig the value of the correlationId property.

setCreationTime

public void setCreationTime(java.util.Date creationTime)

Set the creationTime property.

A date and time to indicate when the call was made.

Parameters:

creationTime - New value of the creationTime property.

getCreationTime

public java.util.Date getCreationTime()

Return the creationTime property.

A date and time to indicate when the call was made.

Returns:

Date containinig the value of the creationTime property.

setRelease

public void setRelease(java.lang.String release)

Set the release property.

A release number associated with the service infrastructure.

Parameters:

release - New value of the release property.

getRelease

public java.lang.String getRelease()

Return the release property.

A release number associated with the service infrastructure.

Returns:

String containinig the value of the release property.

setVersion

public void setVersion(java.lang.String version)

Set the version property.

A version number associated with the service infrastructure.

Parameters:

version - New value of the version property.

getVersion

public java.lang.String getVersion()

Return the version property.

A version number associated with the service infrastructure.

Returns:

String containinig the value of the version property.

setSystemEnvironment

public void setSystemEnvironment(java.lang.String systemEnvironment)

Set the systemEnvironment property.

A code that can be used to distinguish between production ready and test service calls.

Parameters:

systemEnvironment - New value of the systemEnvironment property.

getSystemEnvironment

public java.lang.String getSystemEnvironment()

Return the systemEnvironment property.

A code that can be used to distinguish between production ready and test service calls.

Returns:

String containinig the value of the systemEnvironment property.

setMap

public void setMap(java.util.Map map)

Set the Map containing the bean properties.

Specified by:

setMap in interface DaoBean

Parameters:

map - Map containing bean properties.

getMap

public java.util.Map getMap()

Return the Map containing the bean properties.

Specified by:

getMap in interface DaoBean

Returns:

Map containing bean properties.

getMapping

public java.lang.String getMapping(java.lang.String prop)

Return the mapped value for the provided property name.

Specified by:

getMapping in interface DaoBean

Parameters:

prop - Return the mapping for this property.

Returns:

String containing the mapping for the provided property.

getMappings

public java.util.Map getMappings()

Return the Map containing the property mappings.

Specified by:

getMappings in interface DaoBean

Returns:

Map instance containing property mappings.

create

public static ServiceHeader create(java.util.Map map)
                            throws java.lang.Exception

Create a new ServiceHeader bean instance using the properties in the given Map as the values of the bean properties.

Property mappings are done using Java Reflection and is performed as follows:

The keys in the Map are used as the names of the bean properties. If the Map contains a key with the value name it will be translated into a method call that will invoke the setName(...) method on the target bean using the value associated with the key in the Map.

Parameters:

map - Map containing bean properties.

Returns:

ServiceHeader bean instance.

Throws:

java.lang.Exception - if the bean cannot be created.

toString

public java.lang.String toString()

Return a String representation of this DaoBean instance.

Overrides:

toString in class java.lang.Object

Returns:

String representation of the properties of this bean.