org.sblim.slp

Interface ServiceLocationAttributeDescriptor

public interface ServiceLocationAttributeDescriptor

The ServiceLocationAttributeDescriptor interface provides introspection on a template attribute definition (see RFC 2609). Classes implementing the ServiceLocationAttributeDescriptor interface return information on a particular service location attribute definition from the service template. This information is primarily for GUI tools. Programmatic attribute verification should be done through the ServiceLocationAttributeVerifier.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Enumeration	getAllowedValues() Return an Enumeration of allowed values for the attribute type.
java.util.Enumeration	getDefaultValues() Return an Enumeration of default values for the attribute type.
java.lang.String	getDescription() Return a String containing the attribute's help text.
java.lang.String	getId() Return a String containing the attribute's id.
boolean	getIsKeyword() Returns true if the attribute is a keyword attribute.
boolean	getIsLiteral() Returns true if the "L" flag is set.
boolean	getIsMultivalued() Returns true if the "M" flag is set.
boolean	getIsOptional() Returns true if the "O"" flag is set.
boolean	getRequiresExplicitMatch() Returns true if the "X" flag is set, indicating that the attribute should be included in an any Locator.findServices() request search filter.
java.lang.String	getValueType() Returns a String containing the fully package-qualified Java type of the attribute.

Method Detail

getId

java.lang.String getId()

Return a String containing the attribute's id.

Returns:

The id

getValueType

java.lang.String getValueType()

Returns a String containing the fully package-qualified Java type of the attribute. SLP types are translated into Java types as follows:

SLP	Java
STRING	"java.lang.String"
INTEGER	"java.lang.Integer"
BOOLEAN	"java.lang.Boolean"
OPAQUE	"[B" (byte[])
KEYWORD	"" (empty string)

Returns:

The Java type

getDescription

java.lang.String getDescription()

Return a String containing the attribute's help text.

Returns:

The description

getAllowedValues

java.util.Enumeration getAllowedValues()

Return an Enumeration of allowed values for the attribute type. For keyword attributes returns null. For no allowed values (i.e. unrestricted) returns an empty Enumeration.

Returns:

The allowed values

getDefaultValues

java.util.Enumeration getDefaultValues()

Return an Enumeration of default values for the attribute type. For keyword attributes returns null. For no allowed values (i.e. unrestricted) returns an empty Enumeration.

Returns:

The default values

getRequiresExplicitMatch

boolean getRequiresExplicitMatch()

Returns true if the "X" flag is set, indicating that the attribute should be included in an any Locator.findServices() request search filter.

Returns:

true if "X" is set, false otherwise

getIsMultivalued

boolean getIsMultivalued()

Returns true if the "M" flag is set.

Returns:

true if "M" is set, false otherwise

getIsOptional

boolean getIsOptional()

Returns true if the "O"" flag is set.

Returns:

true if "O" is set, false otherwise

getIsLiteral

boolean getIsLiteral()

Returns true if the "L" flag is set.

Returns:

true if "L" is set, false otherwise

getIsKeyword

boolean getIsKeyword()

Returns true if the attribute is a keyword attribute.

Returns:

true if the attribute is a keyword, false otherwise