Package com.sun.identity.saml2.assertion.impl

Class SubjectLocalityImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.SubjectLocalityImpl

All Implemented Interfaces:

SubjectLocality

public class SubjectLocalityImpl
extends Object
implements SubjectLocality

This class implements interface SubjectLocality. The SubjectLocality element specifies the DNS domain name and IP address for the system entity that performed the authentication. It exists as part of AuthenticationStatement element.

 <complexType name="SubjectLocalityType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="Address" 
       type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="DNSName" 
       type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 

Constructor Summary

Constructors

Constructor	Description
SubjectLocalityImpl()	Class constructor.
SubjectLocalityImpl(String xmlString)	Class constructor with SubjectLocality in xml string format.
SubjectLocalityImpl(Element element)	Class constructor with SubjectLocality in Element format.

Method Summary

Modifier and Type	Method	Description
String	getAddress()	Returns the value of the Address attribute.
String	getDNSName()	Returns the value of the DNSName attribute.
boolean	isMutable()	Returns the mutability of the object.
void	makeImmutable()	Makes the object immutable.
void	setAddress(String value)	Sets the value of the Address attribute.
void	setDNSName(String value)	Sets the value of the DNSName attribute.
String	toXMLString()	Returns a String representation of the element.
String	toXMLString(boolean includeNS, boolean declareNS)	Returns a String representation of the SubjectLocality element.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectLocalityImpl

public SubjectLocalityImpl()

Class constructor. Caller may need to call setters to populate the object.

SubjectLocalityImpl

public SubjectLocalityImpl(Element element)
                    throws SAML2Exception

Class constructor with SubjectLocality in Element format.

Throws:

SAML2Exception

SubjectLocalityImpl

public SubjectLocalityImpl(String xmlString)
                    throws SAML2Exception

Class constructor with SubjectLocality in xml string format.

Throws:

SAML2Exception

Method Detail

makeImmutable

public void makeImmutable()

Makes the object immutable.

Specified by:

makeImmutable in interface SubjectLocality

isMutable

public boolean isMutable()

Returns the mutability of the object.

Specified by:

isMutable in interface SubjectLocality

Returns:

true if the object is mutable; false otherwise.

getDNSName

public String getDNSName()

Returns the value of the DNSName attribute.

Specified by:

getDNSName in interface SubjectLocality

Returns:

the value of the DNSName attribute.

See Also:

setDNSName(String)

setDNSName

public void setDNSName(String value)
                throws SAML2Exception

Sets the value of the DNSName attribute.

Specified by:

setDNSName in interface SubjectLocality

Parameters:

value - new value of the DNSName attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getDNSName()

getAddress

public String getAddress()

Returns the value of the Address attribute.

Specified by:

getAddress in interface SubjectLocality

Returns:

the value of the Address attribute.

See Also:

setAddress(String)

setAddress

public void setAddress(String value)
                throws SAML2Exception

Sets the value of the Address attribute.

Specified by:

setAddress in interface SubjectLocality

Parameters:

value - new value of Address attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAddress()

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element.

Specified by:

toXMLString in interface SubjectLocality

Returns:

A string containing the valid XML for this element. By default name space name is prepended to the element name.

Throws:

SAML2Exception - if the object does not conform to the schema.

toXMLString

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

Returns a String representation of the SubjectLocality element.

Specified by:

toXMLString in interface SubjectLocality

Parameters:

includeNS - 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 containing the valid XML for this element

Throws:

SAML2Exception - if the object does not conform to the schema.