SubjectLocality (OpenSSO Public API)

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.sun.identity.saml2.assertion
インタフェース 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>

メソッドの概要
`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.

メソッドの詳細

makeImmutable

void makeImmutable()

Makes the object immutable.

isMutable

boolean isMutable()

Returns the mutability of the object.

戻り値:: true if the object is mutable; false otherwise.

getDNSName

String getDNSName()

Returns the value of the DNSName attribute.

戻り値:: the value of the DNSName attribute.
関連項目:: SubjectLocality.setDNSName(String)

setDNSName

void setDNSName(String value)
                throws SAML2Exception

Sets the value of the DNSName attribute.

パラメータ:: value - new value of the DNSName attribute.
例外:: SAML2Exception - if the object is immutable.
関連項目:: SubjectLocality.getDNSName()

getAddress

String getAddress()

Returns the value of the Address attribute.

戻り値:: the value of the Address attribute.
関連項目:: SubjectLocality.setAddress(String)

setAddress

void setAddress(String value)
                throws SAML2Exception

Sets the value of the Address attribute.

パラメータ:: value - new value of Address attribute.
例外:: SAML2Exception - if the object is immutable.
関連項目:: SubjectLocality.getAddress()

toXMLString

String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element.

戻り値:: A string containing the valid XML for this element. By default name space name is prepended to the element name.
例外:: 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.

パラメータ:: 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.
戻り値:: A string containing the valid XML for this element
例外:: SAML2Exception - if the object does not conform to the schema.