com.sun.identity.saml2.assertion

Interface SubjectLocality

public 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>
 

Method Summary

Modifier and Type	Method and 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.

Method Detail

makeImmutable

void makeImmutable()

Makes the object immutable.

isMutable

boolean isMutable()

Returns the mutability of the object.

Returns:

true if the object is mutable; false otherwise.

getDNSName

String getDNSName()

Returns the value of the DNSName attribute.

Returns:

the value of the DNSName attribute.

See Also:

SubjectLocality.setDNSName(String)

setDNSName

void setDNSName(String value)
         throws SAML2Exception

Sets the value of the DNSName attribute.

Parameters:

value - new value of the DNSName attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

SubjectLocality.getDNSName()

getAddress

String getAddress()

Returns the value of the Address attribute.

Returns:

the value of the Address attribute.

See Also:

SubjectLocality.setAddress(String)

setAddress

void setAddress(String value)
         throws SAML2Exception

Sets the value of the Address attribute.

Parameters:

value - new value of Address attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

SubjectLocality.getAddress()

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation of the element.

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

String toXMLString(boolean includeNS,
                   boolean declareNS)
            throws SAML2Exception

Returns a String representation of the SubjectLocality element.

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.