com.sun.identity.saml2.protocol.impl

Class RequesterIDImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.RequesterIDImpl

All Implemented Interfaces:

RequesterID

public class RequesterIDImpl
extends Object
implements RequesterID

This interface identifies the requester entities in an AuthnRequest message.

Constructor Summary

Constructors

Constructor and Description
RequesterIDImpl() Constructor to create the RequesterID Object.
RequesterIDImpl(Element element) Constructor to create the RequesterID Object.
RequesterIDImpl(String xmlString) Constructor to create the RequesterID Object.

Method Summary

Modifier and Type	Method and Description
String	getValue() Returns the value of the RequesterID URI.
boolean	isMutable() Returns value true if object is mutable.
void	makeImmutable() Makes this object immutable.
void	setValue(String value) Sets the value of the RequesterID URI.
String	toXMLString() Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation

Methods inherited from class java.lang.Object

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

Constructor Detail

RequesterIDImpl

public RequesterIDImpl()

Constructor to create the RequesterID Object.

RequesterIDImpl

public RequesterIDImpl(Element element)
                throws SAML2Exception

Constructor to create the RequesterID Object.

Parameters:

element - Document Element of RequesterID Object.

Throws:

SAML2Exception - if RequesterID cannot be created.

RequesterIDImpl

public RequesterIDImpl(String xmlString)
                throws SAML2Exception

Constructor to create the RequesterID Object.

Parameters:

xmlString - XML String Representation of RequesterID object.

Throws:

SAML2Exception - if RequesterID cannot be created.

Method Detail

getValue

public String getValue()

Returns the value of the RequesterID URI.

Specified by:

getValue in interface RequesterID

Returns:

value of the RequesterID URI.

See Also:

setValue(String)

setValue

public void setValue(String value)
              throws SAML2Exception

Sets the value of the RequesterID URI.

Specified by:

setValue in interface RequesterID

Parameters:

value - of the RequesterID URI.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getValue()

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface RequesterID

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if cannot convert to String.

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface RequesterID

Parameters:

includeNSPrefix - determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - determines whether or not the namespace is declared within the Element.

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if cannot convert to String.

makeImmutable

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface RequesterID

isMutable

public boolean isMutable()

Returns value true if object is mutable.

Specified by:

isMutable in interface RequesterID

Returns:

true if object is mutable.