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

Part Number E13941-04

weblogic.wsee.security.saml
Interface SAMLCredential

All Known Implementing Classes:
SAMLCredentialImpl

public interface SAMLCredential

User: sychang Date: Jul 19, 2006 Time: 2:27:51 PM


Method Summary
 String getAssertionID()
          AssertionID of SAML Assertion
 SAMLAttributeStatementData getAttributes()
          Get the SAMLAttributeStatemnetInfo or SAML2AttributeStatemnetInfo from the SAML Token
 Object getCredential()
          get the crednetial object
 Element getEncryptedKey()
          get the EncryptedKey Element object
 weblogic.xml.crypto.common.keyinfo.EncryptedKeyProvider getEncryptedKeyProvider()
          get EncryptedKeyProvider object
 Key getHolderOfKey()
          return sender's key for holder-of-key
 PrivateKey getPrivateKey()
          get the private key
 Key getSymmetircKey()
          return symmetric key for holder-of-key
 String getTokenType()
          This method will return TokenType Attribute Value base on the SAML Token as following: V1.1 http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1 V2.0 http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV2.0
 String getVersion()
           
 X509Certificate getX509Cert()
          get the X509 Certificate in this SAML Token.
 boolean isHolderOfKey()
          check is this credential use HoK confirmation
 boolean isSaml2()
           
 void setAttributes(SAMLAttributeStatementData attributes)
          Save the SAML Attributes into this SAML Token
 void setCredential(Object credential)
          set the credential object
 void setEncryptedKeyProvider(weblogic.xml.crypto.common.keyinfo.EncryptedKeyProvider encryptedKeyProvider)
          set EncryptedKeyProvider object
 void setPrivateKey(PrivateKey privateKey)
          set the private key
 void setSymmetircKey(Key symmetircKey)
          set symmetric key for holder-of-key
 

Method Detail

getTokenType

String getTokenType()
This method will return TokenType Attribute Value base on the SAML Token as following:
  1. V1.1 http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1
  2. V2.0 http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV2.0

Null will be reutrned for SAML Token Profile 1.0 type of Token. as there is no Token Type for SAML Token Profile 1.0.

Returns:
TokenType Attribute Value string

getVersion

String getVersion()

isSaml2

boolean isSaml2()

setCredential

void setCredential(Object credential)
set the credential object

Parameters:
credential - SAML assertion node to set

getCredential

Object getCredential()
get the crednetial object

Returns:
SAML assertion object

setPrivateKey

void setPrivateKey(PrivateKey privateKey)
set the private key

Parameters:
privateKey - private key to set

getPrivateKey

PrivateKey getPrivateKey()
get the private key

Returns:
private key

getAssertionID

String getAssertionID()
AssertionID of SAML Assertion

Returns:
assertion id

isHolderOfKey

boolean isHolderOfKey()
check is this credential use HoK confirmation

Returns:
true is it is HoK, false otherwise

getHolderOfKey

Key getHolderOfKey()
return sender's key for holder-of-key

Returns:
the sender's key for holder-of-key

getX509Cert

X509Certificate getX509Cert()
get the X509 Certificate in this SAML Token.

Returns:
X509 Certificate

getAttributes

SAMLAttributeStatementData getAttributes()
Get the SAMLAttributeStatemnetInfo or SAML2AttributeStatemnetInfo from the SAML Token

Returns:
SAMLAttributeStatementData object that can be either SAML 1.1 or SAML 2.0 attributes

setAttributes

void setAttributes(SAMLAttributeStatementData attributes)
Save the SAML Attributes into this SAML Token

Parameters:
attributes - SAMLAttributeStatementData object to be saved

getSymmetircKey

Key getSymmetircKey()
return symmetric key for holder-of-key

Returns:
the symmetric key for holder-of-key

setSymmetircKey

void setSymmetircKey(Key symmetircKey)
set symmetric key for holder-of-key

Parameters:
symmetircKey - the symmetric key for holder-of-key

getEncryptedKey

Element getEncryptedKey()
get the EncryptedKey Element object

Returns:
the encryptedKey Element object, null for no encryptedKey object

getEncryptedKeyProvider

weblogic.xml.crypto.common.keyinfo.EncryptedKeyProvider getEncryptedKeyProvider()
get EncryptedKeyProvider object

Returns:
EncryptedKeyProvider object

setEncryptedKeyProvider

void setEncryptedKeyProvider(weblogic.xml.crypto.common.keyinfo.EncryptedKeyProvider encryptedKeyProvider)
set EncryptedKeyProvider object

Parameters:
encryptedKeyProvider - EncryptedKeyProvider object to be set

Copyright 1996, 2010, 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.4)

Part Number E13941-04