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

Part Number E13941-05

weblogic.wsee.security.saml
Class SAMLAttributeDataImpl

java.lang.Object
  extended by weblogic.wsee.security.saml.SAMLAttributeDataImpl
All Implemented Interfaces:
SAMLAttributeData

public class SAMLAttributeDataImpl
extends Object
implements SAMLAttributeData


Field Summary
static String SAML_2_0_ATTRNAME_FORMAT_BASIC
           
 
Constructor Summary
SAMLAttributeDataImpl()
           
SAMLAttributeDataImpl(SAML2AttributeInfo saml2AttributeInfo)
           
SAMLAttributeDataImpl(SAMLAttributeInfo samlAttributeInfo)
           
SAMLAttributeDataImpl(String attributeName, Collection<String> attributeValues)
           
SAMLAttributeDataImpl(String attributeName, String attributeNameFormat, String attributeFriendlyName, String namespace, Collection<String> attributeValues)
           
 
Method Summary
 void addAttributeValue(String attributeValue)
          add one attribute value
 void addAttributeValues(Collection<String> newAttributeValues)
          add attribute values
static SAMLAttributeData consolation(List<SAMLAttributeData> attributeList)
          This method will add all attribute values into the first SAMLAttributeData object, and return a single SAMLAttributeData object.
 String getAttributeFriendlyName()
          get the Attribute Friendly Name
 String getAttributeName()
          get the attribute name
 String getAttributeNameFormat()
          get the attribute name format for SAML 2.0 only
 String getAttributeNameSpace()
          get the namespace of the Attribute.
 Collection<String> getAttributeValues()
          get the Attribute Value
 SAML2AttributeInfo getSAML2AttributeInfo()
          get a SAML2AttributeInfo object from this object
 SAMLAttributeInfo getSAMLAttributeInfo()
          get a SAMLAttributeInfo object from this object
 boolean isEmpty()
          Check if this attribute data element does not have vlaues
 boolean isSAML20()
          check if this is a SAML 2.0 Attributes
 void setAttributeFriendlyName(String attributeFriendlyName)
          set the Attribute Friendly Name
 void setAttributeName(String attributeName)
          set the attribute name
 void setAttributeNameFormat(String attributeNameFormat)
          set et the attribute name format
 void setAttributeNameSpace(String attributeNameSpace)
          set attributeNameSpace.
 void setAttributeValues(Collection<String> attributeValues)
          set collection of attribute values
 void setSAML20(boolean saml20)
          set this data object to SAML 2.0 attribute object
 String toString()
           
 String valuesToString(String existing)
          Return a String for the array of value String, concatenated with "; "
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SAML_2_0_ATTRNAME_FORMAT_BASIC

public static final String SAML_2_0_ATTRNAME_FORMAT_BASIC
See Also:
Constant Field Values
Constructor Detail

SAMLAttributeDataImpl

public SAMLAttributeDataImpl()

SAMLAttributeDataImpl

public SAMLAttributeDataImpl(String attributeName,
                             Collection<String> attributeValues)

SAMLAttributeDataImpl

public SAMLAttributeDataImpl(String attributeName,
                             String attributeNameFormat,
                             String attributeFriendlyName,
                             String namespace,
                             Collection<String> attributeValues)

SAMLAttributeDataImpl

public SAMLAttributeDataImpl(SAML2AttributeInfo saml2AttributeInfo)

SAMLAttributeDataImpl

public SAMLAttributeDataImpl(SAMLAttributeInfo samlAttributeInfo)
Method Detail

getAttributeName

public String getAttributeName()
get the attribute name

Specified by:
getAttributeName in interface SAMLAttributeData
Returns:
string of the attribute name

setAttributeName

public void setAttributeName(String attributeName)
set the attribute name

Specified by:
setAttributeName in interface SAMLAttributeData
Parameters:
attributeName - string of the attribute name

getAttributeNameFormat

public String getAttributeNameFormat()
get the attribute name format for SAML 2.0 only

Specified by:
getAttributeNameFormat in interface SAMLAttributeData
Returns:
String of the attribute name format, default is SAML_2_0_ATTRNAME_FORMAT_BASIC for SAML 2.0. Null for SAML 1.1.

setAttributeNameFormat

public void setAttributeNameFormat(String attributeNameFormat)
set et the attribute name format

Specified by:
setAttributeNameFormat in interface SAMLAttributeData
Parameters:
attributeNameFormat - String of the attribute name format

getAttributeFriendlyName

public String getAttributeFriendlyName()
get the Attribute Friendly Name

Specified by:
getAttributeFriendlyName in interface SAMLAttributeData
Returns:
String of the Attribute Friendly Name

setAttributeFriendlyName

public void setAttributeFriendlyName(String attributeFriendlyName)
set the Attribute Friendly Name

Specified by:
setAttributeFriendlyName in interface SAMLAttributeData
Parameters:
attributeFriendlyName - the Attribute Friendly Name

getAttributeValues

public Collection<String> getAttributeValues()
get the Attribute Value

Specified by:
getAttributeValues in interface SAMLAttributeData
Returns:
collection of attribute values

setAttributeValues

public void setAttributeValues(Collection<String> attributeValues)
set collection of attribute values

Specified by:
setAttributeValues in interface SAMLAttributeData
Parameters:
attributeValues - collection of attribute values to be set

addAttributeValue

public void addAttributeValue(String attributeValue)
add one attribute value

Specified by:
addAttributeValue in interface SAMLAttributeData
Parameters:
attributeValue - String of attribute value to be added

addAttributeValues

public void addAttributeValues(Collection<String> newAttributeValues)
add attribute values

Specified by:
addAttributeValues in interface SAMLAttributeData
Parameters:
newAttributeValues - collection of attribute values to be added

getAttributeNameSpace

public String getAttributeNameSpace()
get the namespace of the Attribute. This is for SAML 1.1 only.

Specified by:
getAttributeNameSpace in interface SAMLAttributeData
Returns:
string of attribute namespace

setAttributeNameSpace

public void setAttributeNameSpace(String attributeNameSpace)
set attributeNameSpace. This is for SAML 1.1 only.

Specified by:
setAttributeNameSpace in interface SAMLAttributeData
Parameters:
attributeNameSpace - attributeNameSpace to be set

setSAML20

public void setSAML20(boolean saml20)
set this data object to SAML 2.0 attribute object

Parameters:
saml20 - true if it is a SAML 2.0 attribute data

isSAML20

public boolean isSAML20()
check if this is a SAML 2.0 Attributes

Specified by:
isSAML20 in interface SAMLAttributeData
Returns:
true if it is a SAML 2.0 attribute, false otherwise

getSAML2AttributeInfo

public SAML2AttributeInfo getSAML2AttributeInfo()
get a SAML2AttributeInfo object from this object

Specified by:
getSAML2AttributeInfo in interface SAMLAttributeData
Returns:
SAML2AttributeInfo for SAML 2.0

getSAMLAttributeInfo

public SAMLAttributeInfo getSAMLAttributeInfo()
get a SAMLAttributeInfo object from this object

Specified by:
getSAMLAttributeInfo in interface SAMLAttributeData
Returns:
SAMLAttributeInfo for SAML 1.1

consolation

public static SAMLAttributeData consolation(List<SAMLAttributeData> attributeList)
This method will add all attribute values into the first SAMLAttributeData object, and return a single SAMLAttributeData object. Please note that the attribute name will not be verified in this method.

Parameters:
attributeList - SAMLAttributeData objects to be merged
Returns:
a single SAMLAttributeData object

isEmpty

public boolean isEmpty()
Check if this attribute data element does not have vlaues

Specified by:
isEmpty in interface SAMLAttributeData
Returns:
true if the data is empty, no values; false otherwise

valuesToString

public String valuesToString(String existing)
Return a String for the array of value String, concatenated with "; "

Returns:
a string for all values

toString

public String toString()
Overrides:
toString in class Object

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.5)

Part Number E13941-05