Oracle Fusion Middleware
Oracle WebLogic Server API Reference
11g Release 1 (10.3.6)

Part Number E13941-06

weblogic.wsee.security.saml
Interface SAMLAttributeStatementData

All Known Implementing Classes:
SAMLAttributeStatementDataImpl

public interface SAMLAttributeStatementData

This interface represents the attributes in a single AttributeStatment.


Method Summary
 void addAttributeInfo(Collection<SAMLAttributeData> attrs)
          Adds a collection of attributes to this instance, to the end of the existing list, in the order that the param Collection iterates through the Collection.
 void addAttributeInfo(SAMLAttributeData attr)
          Adds a single attribute to this instance, at the end of the existing list.
 Collection<SAMLAttributeData> getAttributeInfo()
          Returns a collection of attributes contained by a single AttributeStatementof a SAML Assertion.
 SAMLAttributeData getAttributeInfo(String AttributeName)
          Returns the SAMLAttributeInfo objecfor a given attribute name.
 Collection<SAML2AttributeStatementInfo> getCollectionsForSAML2AttributeStatementInfo()
          build a collection of SAML2AttributeStatementInfo objects for SAML 2.0
 Collection<SAMLAttributeStatementInfo> getCollectionsForSAMLAttributeStatementInfo()
          build a collection of SAMLAttributeStatementInfo objects for SAML 1.1
 boolean hasAttributeInfo(String attributeName)
          check if the SAMLAttributeInfo object exist for a given attribute name.
 boolean hasAttributeValue(String attributeName, String attributeValue)
           
 boolean isAttributeOnlyRequest()
          check if if this is a SAML Attribute only request.
 boolean isEmpty()
          check if this has empty SAML Attributes collection
 void setAttributeOnlyRequest(boolean attributeOnlyRequest)
          set this is a SAML Attribute only request.
 int size()
          return the size of the SAML Attributes collection in this object.
 

Method Detail

getAttributeInfo

Collection<SAMLAttributeData> getAttributeInfo()
Returns a collection of attributes contained by a single AttributeStatementof a SAML Assertion. The returned Collection is immutable and may be empty.

Returns:
all attributes in this single AttributeStatement

getAttributeInfo

SAMLAttributeData getAttributeInfo(String AttributeName)
Returns the SAMLAttributeInfo objecfor a given attribute name. null will be return, if the attribute is not found.

Returns:
attribute in SAMLAttributeInfo object in this AttributeStatement, null if the attribute is not found

addAttributeInfo

void addAttributeInfo(SAMLAttributeData attr)
Adds a single attribute to this instance, at the end of the existing list.

Parameters:
attr - represents a single attribute to be added

addAttributeInfo

void addAttributeInfo(Collection<SAMLAttributeData> attrs)
Adds a collection of attributes to this instance, to the end of the existing list, in the order that the param Collection iterates through the Collection.

Parameters:
attrs - represents multiple attributes to be added

getCollectionsForSAML2AttributeStatementInfo

Collection<SAML2AttributeStatementInfo> getCollectionsForSAML2AttributeStatementInfo()
build a collection of SAML2AttributeStatementInfo objects for SAML 2.0

Returns:
collection of SAML2AttributeStatementInfo objects

getCollectionsForSAMLAttributeStatementInfo

Collection<SAMLAttributeStatementInfo> getCollectionsForSAMLAttributeStatementInfo()
build a collection of SAMLAttributeStatementInfo objects for SAML 1.1

Returns:
collection of SAMLAttributeStatementInfo objects

isAttributeOnlyRequest

boolean isAttributeOnlyRequest()
check if if this is a SAML Attribute only request. Note: this is used only for the request.

Returns:
true if this is a SAML Attribute only request.

setAttributeOnlyRequest

void setAttributeOnlyRequest(boolean attributeOnlyRequest)
set this is a SAML Attribute only request.

Parameters:
attributeOnlyRequest - set true if this is a SAML Attribute only request

isEmpty

boolean isEmpty()
check if this has empty SAML Attributes collection

Returns:
true if this is an empty, false otherwise

size

int size()
return the size of the SAML Attributes collection in this object. 0 will be return for empty attributes.

Returns:
the size of the SAML Attributes collection

hasAttributeInfo

boolean hasAttributeInfo(String attributeName)
check if the SAMLAttributeInfo object exist for a given attribute name.

Parameters:
attributeName - name of the attribute to be checked
Returns:
true if the given attribute name exists in this AttributeStatement, false otherwise

hasAttributeValue

boolean hasAttributeValue(String attributeName,
                          String attributeValue)
Parameters:
attributeName - name of the attribute to be searched
attributeValue - name of the attribute value to be search

Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server API Reference
11g Release 1 (10.3.6)

Part Number E13941-06