com.sun.identity.saml.assertion

Class AuthorityBinding

java.lang.Object

com.sun.identity.saml.assertion.AuthorityBinding

public class AuthorityBinding
extends Object

The AuthorityBinding element may be used to indicate to a replying party receiving an AuthenticationStatement that a SAML authority may be available to provide additional information about the subject of the statement. A single SAML authority may advertise its presence over multiple protocol binding, at multiple locations, and as more than one kind of authority by sending multiple elements as needed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthorityBinding.AuthorityKindType The AuthorityKindType is an inner class defining constants for the representing the type of SAML protocol queries to which the authority described by this element will respond.

Constructor Summary

Constructors

Constructor and Description
AuthorityBinding(Element element) Constructs an AuthorityBinding element from an existing XML block.
AuthorityBinding(int authKind, String location, String binding) Constructs AuthorityBinding

Method Summary

Modifier and Type	Method and Description
int	getAuthorityKind() Returns the AuthorityKind.
String	getBinding() Gets the binding URI
String	getLocation() Gets the Location URI
String	toString() Returns a String representation of the AuthorityBinding
String	toString(boolean includeNS, boolean declareNS) Returns a String representation of the AuthorityBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorityBinding

public AuthorityBinding(Element element)
                 throws SAMLException

Constructs an AuthorityBinding element from an existing XML block.

Parameters:

element - representing a DOM tree element.

Throws:

SAMLException - if there is an error in the sender or in the element definition.

AuthorityBinding

public AuthorityBinding(int authKind,
                        String location,
                        String binding)
                 throws SAMLException

Constructs AuthorityBinding

Parameters:

authKind - A integer representing the type of SAML protocol queries to which the authority described by this element will respond. If you do NO specify this attribute, pass in value "-1".

location - A URI describing how to locate and communicate with the authority, the exact syntax of which depends on the protocol binding in use.

binding - A String representing a URI reference identifying the SAML protocol binding to use in communicating with the authority.

Throws:

SAMLException - if there is an error in the sender or in the element definition.

Method Detail

getLocation

public String getLocation()

Gets the Location URI

Returns:

A String representing the URI describing how to locate and communicate with the authority, the exact syntax of which depends on the protocol binding in use.

getBinding

public String getBinding()

Gets the binding URI

Returns:

A String representing a URI reference identifying the SAML protocol binding to use in communicating with the authority.

getAuthorityKind

public int getAuthorityKind()

Returns the AuthorityKind.

Returns:

A integer representing the type of SAML protocol queries to which the authority described by this element will respond.

toString

public String toString()

Returns a String representation of the AuthorityBinding

Overrides:

toString in class Object

Returns:

A String representation of the AuthorityBinding element.

toString

public String toString(boolean includeNS,
                       boolean declareNS)

Returns a String representation of the AuthorityBinding

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 representation of the AuthorityBinding element.