com.sun.identity.liberty.ws.disco

Class Description

java.lang.Object

com.sun.identity.liberty.ws.disco.Description

public class Description
extends Object

The class Description represents a Description Type of a service instance.

The following schema fragment specifies the expected content within the Description object.

 <complexType name="DescriptionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="SecurityMechID" type="{http://www.w3.org/2001/XMLSchema}anyURI" maxOccurs="unbounded"/>
         <element name="CredentialRef" type="{http://www.w3.org/2001/XMLSchema}IDREF" maxOccurs="unbounded" minOccurs="0"/>
         <choice>
           <group ref="{urn:liberty:disco:2003-08}WsdlRef"/>
           <group ref="{urn:liberty:disco:2003-08}BriefSoapHttpDescription"/>
         </choice>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Constructor Summary

Constructors

Constructor and Description
Description() Default constructor.
Description(Element elem) Constructs a Description object from DOM element.
Description(List securityMechID, List credentialRef, String endPoint) Constructor.

Method Summary

Modifier and Type	Method and Description
List	getCredentialRef() Gets the value of the CredentialRef property.
String	getEndpoint() Gets SOAP end point URI.
String	getId() Gets id attribute.
List	getSecurityMechID() Gets supported Security Mechanism IDs.
void	getSecurityMechID(List mechIDs) Sets supported Security Mechanism IDs.
QName	getServiceNameRef() Gets WSDL service name reference.
String	getSoapAction() Gets SOAP action.
String	getWsdlURI() Gets URI to WSDL resource containing the service description.
void	setCredentialRef(List refs) Sets the value of the CredentialRef property.
void	setEndpoint(String uri) Sets SOAP end point URI.
void	setId(String id) Sets id attribute.
void	setServiceNameRef(QName nameRef) Sets WSDL service name reference.
void	setSoapAction(String value) Sets SOAP action.
void	setWsdlURI(String uri) Sets URI to WSDL resource containing the service description.
String	toString() Returns formatted string of the service description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Description

public Description()

Default constructor.

Description

public Description(List securityMechID,
                   List credentialRef,
                   String endPoint)

Constructor.

Parameters:

securityMechID - List of supported security mechanism ID as String

credentialRef - List of credential references

endPoint - SOAP endpoint URI

Description

public Description(Element elem)
            throws DiscoveryException

Constructs a Description object from DOM element.

Parameters:

elem - DOM Element of Description.

Throws:

DiscoveryException - if error occurs.

Method Detail

getId

public String getId()

Gets id attribute.

Returns:

id attribute.

See Also:

Description.setId(String)

setId

public void setId(String id)

Sets id attribute.

Parameters:

id - id attribute.

See Also:

Description.getId()

getSoapAction

public String getSoapAction()

Gets SOAP action.

Returns:

SOAP action.

See Also:

Description.setSoapAction(String)

setSoapAction

public void setSoapAction(String value)

Sets SOAP action.

Parameters:

value - SOAP action to be set

See Also:

Description.getSoapAction()

getSecurityMechID

public List getSecurityMechID()

Gets supported Security Mechanism IDs.

Returns:

List of IDs as String for security mechanism

getSecurityMechID

public void getSecurityMechID(List mechIDs)

Sets supported Security Mechanism IDs.

Parameters:

mechIDs - List of IDs as String for security mechanism

getServiceNameRef

public QName getServiceNameRef()

Gets WSDL service name reference.

Returns:

WSDL service name reference.

See Also:

Description.setServiceNameRef(QName)

setServiceNameRef

public void setServiceNameRef(QName nameRef)

Sets WSDL service name reference.

Parameters:

nameRef - service name reference.

See Also:

Description.getServiceNameRef()

getWsdlURI

public String getWsdlURI()

Gets URI to WSDL resource containing the service description.

Returns:

URI to WSDL resource containing the service description.

See Also:

Description.setWsdlURI(String)

setWsdlURI

public void setWsdlURI(String uri)

Sets URI to WSDL resource containing the service description.

Parameters:

uri - URI to the WSDL resource

See Also:

Description.getWsdlURI()

getCredentialRef

public List getCredentialRef()

Gets the value of the CredentialRef property.

Returns:

value of the CredentialRef property.

See Also:

Description.setCredentialRef(List)

setCredentialRef

public void setCredentialRef(List refs)

Sets the value of the CredentialRef property.

Parameters:

refs - List of String value of the CredentialRef property.

See Also:

Description.getCredentialRef()

getEndpoint

public String getEndpoint()

Gets SOAP end point URI.

Returns:

SOAP end point URI

See Also:

Description.setEndpoint(String)

setEndpoint

public void setEndpoint(String uri)

Sets SOAP end point URI.

Parameters:

uri - end point URI to be set

See Also:

Description.getEndpoint()

toString

public String toString()

Returns formatted string of the service description.

Overrides:

toString in class Object

Returns:

formatted string of the service description.