com.sonicsw.esb.mgmtapi.config
Interface IParameter

public interface IParameter

Represent the meta-data and value associate with initialization and runtime parameters associated with a service. For runtime parameter only meta-data is accessible (since runtime parameter values are specified in processes).

Dedicated interfaces provide access to type specific parameter constraints (e.g. for integer parameters min and max values).

Nested Class Summary

static interface	IParameter.IAddressParameter Convenience interface for Address related parameters (Address, Service, Process)
static interface	IParameter.IBooleanParam Convenience interface for parameters of type Boolean.
static interface	IParameter.IDoubleParamater Convenience interface for parameters of type Double.
static interface	IParameter.IEnumParameter Convenience interface for enumerated parameters
static interface	IParameter.IFileResourceParameter Convenience interface for parameters of type File resource.
static interface	IParameter.IFloatParamater Convenience interface for parameters of type Float.
static interface	IParameter.IIntegerParamater Convenience interface for parameters of type Integer.
static interface	IParameter.ILongParamater Convenience interface for parameters of type Long.
static interface	IParameter.IStringParameter Convenience interface for parameters of type String.
static interface	IParameter.IXMLResourceParameter Convenience interface for parameters of type XML resource.
static class	IParameter.ParameterType

Field Summary

static IParameter.ParameterType	ADDRESS_TYPE
static IParameter.ParameterType	BOOLEAN_TYPE
static IParameter.ParameterType	COMMAND_TYPE
static IParameter.ParameterType	DESTINATION_TYPE
static IParameter.ParameterType	DOUBLE_TYPE
static IParameter.ParameterType	ENDPOINT_TYPE
static IParameter.ParameterType	ENUM_TYPE
static IParameter.ParameterType	FILE_RESOURCE_LIST_TYPE
static IParameter.ParameterType	FILE_RESOURCE_TYPE
static IParameter.ParameterType	FLOAT_TYPE
static IParameter.ParameterType	INLINE_XML_TYPE
static IParameter.ParameterType	INTEGER_TYPE
static IParameter.ParameterType	INTERFACE_IDENTIFIER_TYPE
static IParameter.ParameterType	LONG_TYPE
static IParameter.ParameterType	OPERATION_IDENTIFIER_TYPE
static IParameter.ParameterType	PASSWORD_TYPE
static IParameter.ParameterType	PROCESS_TYPE
static IParameter.ParameterType	SERVICE_TYPE
static IParameter.ParameterType	STRING_TYPE
static IParameter.ParameterType	XML_RESOURCE_TYPE

Method Summary

java.lang.Object	getAsTypedParameter() Return an instance of a type specific parameter, based on the configured parameter type (e.g. an instance of IIntegerParameter assuming the parameter is of type integer).
java.lang.Object	getAsTypedParameter(IParameter.ParameterType type) Return an object implementing the appropriate interface of IxxxParameter, which allows setting and querying values in a typed manner.
java.lang.String	getDisplayName()
java.lang.String	getLongDesc()
java.lang.String	getName()
IParameter.ParameterType	getParameterType()
java.lang.String	getPropertyEditorClassName()
java.lang.String	getShortDesc()
java.lang.String	getValueAsString() Only applicable to Init parameters, when obtained from a service configuration.
java.lang.String	getXmlSchemaLocation()
boolean	isHiddenParameter()
boolean	isInitParameter()
boolean	isRequired()
boolean	isRuntimeParameter()

Field Detail

ENUM_TYPE

static final IParameter.ParameterType ENUM_TYPE

INLINE_XML_TYPE

static final IParameter.ParameterType INLINE_XML_TYPE

XML_RESOURCE_TYPE

static final IParameter.ParameterType XML_RESOURCE_TYPE

FILE_RESOURCE_TYPE

static final IParameter.ParameterType FILE_RESOURCE_TYPE

FILE_RESOURCE_LIST_TYPE

static final IParameter.ParameterType FILE_RESOURCE_LIST_TYPE

BOOLEAN_TYPE

static final IParameter.ParameterType BOOLEAN_TYPE

INTEGER_TYPE

static final IParameter.ParameterType INTEGER_TYPE

LONG_TYPE

static final IParameter.ParameterType LONG_TYPE

FLOAT_TYPE

static final IParameter.ParameterType FLOAT_TYPE

DOUBLE_TYPE

static final IParameter.ParameterType DOUBLE_TYPE

STRING_TYPE

static final IParameter.ParameterType STRING_TYPE

PASSWORD_TYPE

static final IParameter.ParameterType PASSWORD_TYPE

ENDPOINT_TYPE

static final IParameter.ParameterType ENDPOINT_TYPE

SERVICE_TYPE

static final IParameter.ParameterType SERVICE_TYPE

PROCESS_TYPE

static final IParameter.ParameterType PROCESS_TYPE

ADDRESS_TYPE

static final IParameter.ParameterType ADDRESS_TYPE

DESTINATION_TYPE

static final IParameter.ParameterType DESTINATION_TYPE

COMMAND_TYPE

static final IParameter.ParameterType COMMAND_TYPE

INTERFACE_IDENTIFIER_TYPE

static final IParameter.ParameterType INTERFACE_IDENTIFIER_TYPE

OPERATION_IDENTIFIER_TYPE

static final IParameter.ParameterType OPERATION_IDENTIFIER_TYPE

Method Detail

getParameterType

IParameter.ParameterType getParameterType()

isRequired

boolean isRequired()

isInitParameter

boolean isInitParameter()

isRuntimeParameter

boolean isRuntimeParameter()

isHiddenParameter

boolean isHiddenParameter()

getPropertyEditorClassName

java.lang.String getPropertyEditorClassName()

getName

java.lang.String getName()

getDisplayName

java.lang.String getDisplayName()

getShortDesc

java.lang.String getShortDesc()

getLongDesc

java.lang.String getLongDesc()

getXmlSchemaLocation

java.lang.String getXmlSchemaLocation()

getValueAsString

java.lang.String getValueAsString()

Only applicable to Init parameters, when obtained from a service configuration. The following parameters' values can not be accessed via this method:

1. - Runtime parameters
2. - Init parameters obtained from a service type configuration

   Returns:

   A string representation of the parameter's value

getAsTypedParameter

java.lang.Object getAsTypedParameter(IParameter.ParameterType type)

Return an object implementing the appropriate interface of IxxxParameter, which allows setting and querying values in a typed manner. The returned object might or might not be the same instance as the parameter, but operations on this object will be reflected in the value of the parameter.

Parameters:

type - a parameter type safe-enum value.

Returns:

an instance of an object implementing access according to requested parameter type

getAsTypedParameter

java.lang.Object getAsTypedParameter()

Return an instance of a type specific parameter, based on the configured parameter type (e.g. an instance of IIntegerParameter assuming the parameter is of type integer).

Returns:

an instance of an object implementing access accorting to the parameter's type