com.aurea.sonic.esb.pojo.annotation

Annotation Type InitParameter

@Documented
 @Inherited
 @Target(value=FIELD)
 @Retention(value=CLASS)
public @interface InitParameter

The InitParameter annotation specifies an attribute of SonicPOJO ESB Service. Indicates that the annotated field is configured by a service instance initialization parameter. Service initialization parameters permit specialization of each POJO service instance and associated fields are set on service startup, Annotation attributes describe UI rendering, validation and initialization characteristics of the service configuration initialization parameter.

Since:

10.0.7

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	defaultValue Init parameter default value
java.lang.String	description Init parameter description
java.lang.String	displayName Init parameter display name(default: the field name)
boolean	enableSubstitution Init parameter enable substution(default false)
boolean	hidden Init parameter hidden(default false)
java.lang.String	name Init parameter name(default: the field name)
boolean	password Init parameter for password(default false)
boolean	readOnly Init parameter read only(default false)
boolean	required Init parameter required(default false)

Element Detail

name

public abstract java.lang.String name

Init parameter name(default: the field name)

Returns:

init parameter name, used by programming APIs

Default:

""

displayName

public abstract java.lang.String displayName

Init parameter display name(default: the field name)

Returns:

label used by UIs to display the parameter

Default:

""

description

public abstract java.lang.String description

Init parameter description

Returns:

descriptive text about the parameter usage and values

Default:

""

required

public abstract boolean required

Init parameter required(default false)

Returns:

indicates whether the UI requires a parameter to be entered

Default:

false

hidden

public abstract boolean hidden

Init parameter hidden(default false)

Returns:

indicates whether the UI hides the parameter from the user

Default:

false

password

public abstract boolean password

Init parameter for password(default false)

Returns:

indicates whether it is password or not.

Default:

false

readOnly

public abstract boolean readOnly

Init parameter read only(default false)

Returns:

indicates whether the UI disables changing the parameter from the defaulted value

Default:

false

enableSubstitution

public abstract boolean enableSubstitution

Init parameter enable substution(default false)

Returns:

indicates if the UI entry supports a entering of a variable that is evaluated at service startime to a real value, for example, variables can specify a container deployment parameter, JVM or property file property.

Default:

false

defaultValue

public abstract java.lang.String defaultValue

Init parameter default value

Returns:

default value of init parameter

Default:

""