org.apache.ws.resource
Interface ResourceKey

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
AbstractResourceKey

public interface ResourceKey
extends java.io.Serializable

A basic representation of a resource key. A resource key is composed of name and the actual resource key value.


Method Summary
 javax.xml.namespace.QName getName()
          The name of the key.
 java.lang.Class getType()
          Returns the class representation of the ResourceKey implementation.
 java.lang.Object getValue()
          The actual key value.
 javax.xml.soap.SOAPElement toSOAPElement()
          Converts the resource key into a SOAPElement.
 

Method Detail

getName

public javax.xml.namespace.QName getName()
The name of the key.

Returns:
the name of the key. Cannot be null.

getValue

public java.lang.Object getValue()
The actual key value.

Returns:
the key value. Cannot be null.

toSOAPElement

public javax.xml.soap.SOAPElement toSOAPElement()
                                         throws org.apache.commons.lang.SerializationException
Converts the resource key into a SOAPElement. The element name and namespace must match the name of the key.

Returns:
the resource key as a SOAPElement
Throws:
org.apache.commons.lang.SerializationException - in case the conversion fails.

getType

public java.lang.Class getType()
Returns the class representation of the ResourceKey implementation.

Returns:
The Class of the key type.


Copyright © 2004-2005 Apache Software Foundation. All Rights Reserved.