bea.jolt

Class JoltDefinition

java.lang.Object

bea.jolt.JoltDefAttrs

bea.jolt.JoltDefinition

public class JoltDefinition
extends JoltDefAttrs

This class represents the definition of a Jolt object that can be both a service and an asynchronous message.

See Also:

JoltRemoteService, JoltMessage

Field Summary

Fields inherited from class bea.jolt.JoltDefAttrs

AVLIST, BINARY, BOE, BOOLEAN, BOP, BYTE, CONVERSATION, DOUBLE, EOE, EOP, EVENT, FLOAT, IBUFTYPE, INTEGER, IVIEWNAME, LONG, MANDATORY, NOACC, OBUFTYPE, OPTIONAL, OVIEWNAME, PARMACC, PARMDESC, PARMFID, PARMFINDEX, PARMFNAME, PARMLEN, PARMNAME, PARMOCC, PARMSTATUS, PARMSUBTYPE, PARMTYPE, QSPACE, QUEUE, RDONLY, RDWR, SERVICE, SHORT, STRING, VERSION, VIEW32, WRONLY

Constructor Summary

Constructors

Constructor and Description
JoltDefinition(java.lang.String svcdef) This constructor takes a string definition and converts it into an object.
JoltDefinition(java.lang.String name, java.lang.String typeName) This contstructor builds a new definition.

Method Summary

Methods

Modifier and Type	Method and Description
JoltParam	addParam(java.lang.String nm, JoltParam param, JoltParam prev) Add parameter to the hash table and the linked list.
java.util.Enumeration	getKeys() Enumerates the property keys.
java.lang.String	getName() Get the name of the definition (e.g.
JoltParam	getParam(java.lang.String name) Get the parameter object for the name.
java.util.Enumeration	getParams() Enumerates the parameter list.
java.lang.String	getProperty(java.lang.String name) Get a property element of the definition.
int	getType() Get the type of definition.
java.lang.String	getTypeName() Get the key token to the repository.
int	getVersion() Get the version number of the definition.
int	numParams() Get the number of parameters in the hash (which excludes duplicate parameter definitions).
int	numParamsInList() Get the number of parameters in the list (which includes duplicate parameter definitions).
void	putProperty(java.lang.String name, java.lang.String val) Put a property element for the definition.
java.lang.String	toString() Build the definition string from this object.

Methods inherited from class bea.jolt.JoltDefAttrs

getInteger

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JoltDefinition

public JoltDefinition(java.lang.String name,
              java.lang.String typeName)

This contstructor builds a new definition.

Parameters:

name - The service name

typeName - The key to the repository.

JoltDefinition

public JoltDefinition(java.lang.String svcdef)
               throws DefinitionException

This constructor takes a string definition and converts it into an object.

Parameters:

svcdef - The definition in a string.

Throws:

DefinitionException - Malformed definition.

Method Detail

getName

public java.lang.String getName()

Get the name of the definition (e.g. the service name) for this object.

Returns:

The definition name.

getVersion

public int getVersion()

Get the version number of the definition.

Returns:

The definition version number.

getTypeName

public java.lang.String getTypeName()

Get the key token to the repository.

getType

public int getType()

Get the type of definition.

Returns:

The type of the definition.

See Also:

Request.SERVICE, Request.QUEUE

numParams

public int numParams()

Get the number of parameters in the hash (which excludes duplicate parameter definitions).

Returns:

the number of parameters.

numParamsInList

public int numParamsInList()

Get the number of parameters in the list (which includes duplicate parameter definitions).

Returns:

the number of parameters.

getParams

public java.util.Enumeration getParams()

Enumerates the parameter list.

Returns:

Enumeration of the parameter.

getParam

public JoltParam getParam(java.lang.String name)
                   throws java.lang.NoSuchFieldError

Get the parameter object for the name.

Parameters:

name - the parameter name.

Returns:

the parameter object

Throws:

java.lang.NoSuchFieldError - This field does not exist.

getProperty

public java.lang.String getProperty(java.lang.String name)

Get a property element of the definition.

Parameters:

name - the property name.

Returns:

the property value.

putProperty

public void putProperty(java.lang.String name,
               java.lang.String val)

Put a property element for the definition.

Parameters:

name - the property name.

val - the property value.

getKeys

public java.util.Enumeration getKeys()

Enumerates the property keys.

Returns:

the enumeration of the property keys.

toString

public java.lang.String toString()

Build the definition string from this object.

Overrides:

toString in class java.lang.Object

Returns:

The definition string.

addParam

public JoltParam addParam(java.lang.String nm,
                 JoltParam param,
                 JoltParam prev)

Add parameter to the hash table and the linked list. This method returns the current param which must be passed back as the "prev" in the subsequent call. The very first time to call this method, "prev" must be null.

Parameters:

nm - the name of the parameter

param - the parameter object to be added

prev - the previous parameter object

Returns:

The added parameter object.