amwebarsentitlementservice.container
Class AMWebARSContainerDescriptor

java.lang.Object
  |
  +--amwebarsentitlementservice.container.AMWebARSContainerDescriptor
All Implemented Interfaces:
java.io.Serializable

public class AMWebARSContainerDescriptor
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Field Summary
static java.lang.String CLIENT_INIT_PROPERTY_XML_NAME
           
static java.lang.String CONTAINER_NAME_XML_NAME
           
static java.lang.String CONTAINER_TYPE_ID_XML_NAME
           
static java.lang.String COST_XML_NAME
           
static java.lang.String DESCRIPTOR_XML_NAME
           
static java.lang.String NAMESPACE_XML_NAME
           
static java.lang.String PAYLOAD_FORMAT_XML_NAME
           
static java.lang.String PROTOCOL_ID_XML_NAME
           
static java.lang.String PROVIDER_ID_XML_NAME
           
 
Method Summary
 void clearClientInitProperties()
          Removes all values from the container descriptor's client init Properties.
 void clearProperties()
          Removes all values from the container descriptor's Properties.
 java.util.Enumeration clientInitPropertyNames()
          Returns an Enumeration of all keys of the container descriptor's client init Properties.
 boolean equals(java.lang.Object other_object)
          Tests whether this AMWebARSContainerDescriptor is equal to another.
 java.lang.String getClientInitProperty(java.lang.String key)
          Returns a Property value of the container descriptor's client init properies.
 java.lang.String getClientInitProperty(java.lang.String key, java.lang.String default_val)
          Returns a Property value of the container descriptor's client init properies.
 AMWebARSContainer getContainerInstance()
          Generates a AMWebARSContainer for this AMWebARSContainerDescriptor.
 java.lang.String getContainerName()
          Gets the container_name.
 java.lang.String getContainerTypeID()
          Gets the container_type_id.
 java.lang.String getCost()
          Gets the cost.
 DependencyTerm getDependency()
          Gets the dependency.
static AMWebARSContainerDescriptor getInstance(java.lang.String container_type_id)
          Returns the container instance with the given container_type_id.
 java.lang.String getNamespacePrefix()
          Gets the namespace_prefix.
 org.jdom.Element getPayloadFormat()
          Gets the payload_format.
 java.lang.String getProperty(java.lang.String key)
          Returns a Property value of the container descriptor's properies.
 java.lang.String getProperty(java.lang.String key, java.lang.String default_val)
          Returns a Property value of the container descriptor's properies.
 java.lang.String getProtocolID()
          Gets the protocol_id.
 java.lang.String getProviderID()
          Gets the provider_id.
 int hashCode()
          Delegates the hashCode to the container_type_ids hashCode
 java.util.Enumeration propertyNames()
          Returns an Enumeration of all keys of the container descriptor's Properties.
 java.lang.Object setClientInitProperty(java.lang.String key, java.lang.String value)
          Sets a Property value in the client init properties.
 void setCost(java.lang.String cost)
          Sets the cost.
 void setDependency(DependencyTerm dependency)
          Sets the dependency.
 void setPayloadFormat(org.jdom.Element payload_format)
          Sets the payload_format.
 java.lang.Object setProperty(java.lang.String key, java.lang.String value)
          Sets a Property value.
 void setProtocolID(java.lang.String protocol_id)
          Sets the protocol_id.
 void setProviderID(java.lang.String provider_id)
          Sets the provider_id.
 java.util.Properties toProperties()
          Generates an Properies object for this container descriptor.
 java.lang.String toString()
          Generates the String representation of this container descriptor.
 org.jdom.Element toXML()
          Translates the ContainerDescriptor to XML
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DESCRIPTOR_XML_NAME

public static final java.lang.String DESCRIPTOR_XML_NAME

CONTAINER_TYPE_ID_XML_NAME

public static final java.lang.String CONTAINER_TYPE_ID_XML_NAME

CONTAINER_NAME_XML_NAME

public static final java.lang.String CONTAINER_NAME_XML_NAME

NAMESPACE_XML_NAME

public static final java.lang.String NAMESPACE_XML_NAME

COST_XML_NAME

public static final java.lang.String COST_XML_NAME

PROTOCOL_ID_XML_NAME

public static final java.lang.String PROTOCOL_ID_XML_NAME

PROVIDER_ID_XML_NAME

public static final java.lang.String PROVIDER_ID_XML_NAME

PAYLOAD_FORMAT_XML_NAME

public static final java.lang.String PAYLOAD_FORMAT_XML_NAME

CLIENT_INIT_PROPERTY_XML_NAME

public static final java.lang.String CLIENT_INIT_PROPERTY_XML_NAME
Method Detail

getInstance

public static AMWebARSContainerDescriptor getInstance(java.lang.String container_type_id)
Returns the container instance with the given container_type_id.
Returns:
AMWebARSContainerDescriptor of the container_type_id.

getContainerTypeID

public java.lang.String getContainerTypeID()
Gets the container_type_id.
Returns:
Returns a String

getNamespacePrefix

public java.lang.String getNamespacePrefix()
Gets the namespace_prefix.
Returns:
Returns a String

getContainerName

public java.lang.String getContainerName()
Gets the container_name.
Returns:
Returns a String

getCost

public java.lang.String getCost()
Gets the cost.
Returns:
Returns a String

setCost

public void setCost(java.lang.String cost)
Sets the cost.
Parameters:
cost - The cost to set

getProtocolID

public java.lang.String getProtocolID()
Gets the protocol_id.
Returns:
Returns a String

setProtocolID

public void setProtocolID(java.lang.String protocol_id)
Sets the protocol_id.
Parameters:
protocol_id - The protocol_id to set

getProviderID

public java.lang.String getProviderID()
Gets the provider_id.
Returns:
Returns a String

setProviderID

public void setProviderID(java.lang.String provider_id)
Sets the provider_id.
Parameters:
provider_id - The provider_id to set

getPayloadFormat

public org.jdom.Element getPayloadFormat()
Gets the payload_format.
Returns:
Returns a Document

setPayloadFormat

public void setPayloadFormat(org.jdom.Element payload_format)
Sets the payload_format.
Parameters:
payload_format - The payload_format to set

getDependency

public DependencyTerm getDependency()
Gets the dependency.
Returns:
Returns a DependencyTerm

setDependency

public void setDependency(DependencyTerm dependency)
Sets the dependency.
Parameters:
dependency - The dependency to set

getProperty

public java.lang.String getProperty(java.lang.String key)
Returns a Property value of the container descriptor's properies.
Parameters:
key - of the property
Returns:
value of the property, null if it's not set.

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String default_val)
Returns a Property value of the container descriptor's properies.
Parameters:
key - of the property
Returns:
value of the property, returns the default_val if it's not set.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                                    java.lang.String value)
Sets a Property value.
Parameters:
key - of the property that's set
value - to set the property to
Returns:
the value of the Hashtable set before

propertyNames

public java.util.Enumeration propertyNames()
Returns an Enumeration of all keys of the container descriptor's Properties.
Returns:
Enumeration of keys

clearProperties

public void clearProperties()
Removes all values from the container descriptor's Properties.

getClientInitProperty

public java.lang.String getClientInitProperty(java.lang.String key)
Returns a Property value of the container descriptor's client init properies.
Parameters:
key - of the property
Returns:
value of the property, null if it's not set.

getClientInitProperty

public java.lang.String getClientInitProperty(java.lang.String key,
                                              java.lang.String default_val)
Returns a Property value of the container descriptor's client init properies.
Parameters:
key - of the property
Returns:
value of the property, returns the default_val if it's not set.

setClientInitProperty

public java.lang.Object setClientInitProperty(java.lang.String key,
                                              java.lang.String value)
Sets a Property value in the client init properties.
Parameters:
key - of the property that's set
value - to set the property to
Returns:
the value of the Hashtable set before

clientInitPropertyNames

public java.util.Enumeration clientInitPropertyNames()
Returns an Enumeration of all keys of the container descriptor's client init Properties.
Returns:
Enumeration of keys

clearClientInitProperties

public void clearClientInitProperties()
Removes all values from the container descriptor's client init Properties.

toProperties

public java.util.Properties toProperties()
Generates an Properies object for this container descriptor.
Returns:
Properties object. This corresponds to an AttributeList on the AccessManagers side.

getContainerInstance

public AMWebARSContainer getContainerInstance()
Generates a AMWebARSContainer for this AMWebARSContainerDescriptor.
Returns:
new AMWebARSContainer. The payload of that container validates under the payload_format of this AMWebARSContainerDescriptor.

hashCode

public int hashCode()
Delegates the hashCode to the container_type_ids hashCode
Overrides:
hashCode in class java.lang.Object
Returns:
int hashCode

equals

public boolean equals(java.lang.Object other_object)
Tests whether this AMWebARSContainerDescriptor is equal to another.
Overrides:
equals in class java.lang.Object
Returns:
boolean true if both obj are the same.

toString

public java.lang.String toString()
Generates the String representation of this container descriptor.
Overrides:
toString in class java.lang.Object
Returns:
String

toXML

public org.jdom.Element toXML()
Translates the ContainerDescriptor to XML
Returns:
XML Element of the ContainerDescriptor