WebLogic Server 8.1 API Reference

weblogic.xml.security.specs
Class SecuritySpec

java.lang.Object
  |
  +--weblogic.xml.security.specs.SecuritySpec

public class SecuritySpec

extends java.lang.Object

implements weblogic.xml.security.specs.SpecConstants

The class represents the top level node of a SecuritySpec. The SecuritySpec is used to described desired WSSE Security elements, independent of the WSSE version. These are specs are the basis of inbound and outbound policy in WLS. Created: Sat Aug 10 18:10:49 2002

Author:

Copyright © 2004 BEA Systems, Inc. All Rights Reserved.

Field Summary

static java.lang.String

DEFAULT_SPEC_ID

Constructor Summary

SecuritySpec()

SecuritySpec(java.lang.String name, java.lang.String targetNS)
Creates a new SecuritySpec instance.

SecuritySpec(java.lang.String name, java.lang.String targetNS, java.lang.String actorURI)
Creates a new SecuritySpec instance.

Method Summary

Security	createSecurity(java.lang.String role, weblogic.xml.security.specs.TimestampConfig tsConfig, java.lang.String username, java.lang.String password, java.security.cert.X509Certificate encryptCert, java.security.PrivateKey sigKey, java.security.cert.X509Certificate sigCert, SecurityElementFactory factory)
boolean	getEnablePasswordAuth() Returns whether Password based auth has been enabled for this spec.
EncryptionSpec	getEncryptionSpec() Returns the EncryptionSpec for this SecuritySpec
java.lang.String	getId() Returns the id for this SecuritySpec
java.lang.String	getRole() Returns the role for this SecuritySpec
SignatureSpec	getSignatureSpec() Returns the SignatureSpec for this SecuritySpec
weblogic.xml.security.specs.BinarySecurityTokenSpec	setBinarySecurityTokenSpec(weblogic.xml.security.specs.BinarySecurityTokenSpec spec) addBinarySecurityTokenSpec adds a spec for a BinarySecurityTokenImpl to the SecuritySpec.
weblogic.xml.security.specs.BinarySecurityTokenSpec	setBinarySecurityTokenSpec(java.lang.String type) addBinarySecurityTokenSpec adds a spec for a BinarySecurityTokenImpl to the SecuritySpec.
void	setEnablePasswordAuth(boolean enable) enables plain text password auth for this SecuritySpec
EncryptionSpec	setEncryptionSpec(EncryptionSpec spec)
EncryptionSpec	setEncryptionSpec(java.lang.String encryptionURI, java.security.cert.X509Certificate cert) addEncryptionSpec adds a spec for encrypted data to the SecuritySpec.
EncryptionSpec	setEncryptionSpec(java.lang.String encryptionURI, java.security.cert.X509Certificate cert, boolean encryptBody) addEncryptionSpec adds a spec for encrypted data to the SecuritySpec.
void	setId(java.lang.String id)
void	setNamespace(java.lang.String namespace)
void	setRole(java.lang.String role)
SignatureSpec	setSignatureSpec(SignatureSpec spec) setSignatureSpec adds the provided signatureSpec to this SecuritySpec
SignatureSpec	setSignatureSpec(java.lang.String canonicalizationURI, java.lang.String signatureURI) setSignatureSpec adds a SignatureSpec to the SecuritySpec element.
SignatureSpec	setSignatureSpec(java.lang.String canonicalizationURI, java.lang.String signatureURI, boolean signedBody) setSignatureSpec adds a SignatureSpec to the SecuritySpec element.
weblogic.xml.security.specs.UsernameTokenSpec	setUsernameTokenSpec(java.lang.String passwordType) setUsernameTokenSpec adds a UsernameTokenSpec to the SecuritySpec element.
weblogic.xml.security.specs.UsernameTokenSpec	setUsernameTokenSpec(java.lang.String passwordType, java.lang.String realm) setUsernameTokenSpec adds a UsernameTokenSpec to the SecuritySpec element.
weblogic.xml.security.specs.UsernameTokenSpec	setUsernameTokenSpec(weblogic.xml.security.specs.UsernameTokenSpec spec) setUsernameTokenSpec adds a UsernameTokenSpec to the SecuritySpec element.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SPEC_ID

public static final java.lang.String DEFAULT_SPEC_ID

Constructor Detail

SecuritySpec

public SecuritySpec()

SecuritySpec

public SecuritySpec(java.lang.String name,
                    java.lang.String targetNS)

Creates a new SecuritySpec instance.

Parameters:

name - a String value

targetNS - a String value identifying the namespace to be used for Security elements.

SecuritySpec

public SecuritySpec(java.lang.String name,
                    java.lang.String targetNS,
                    java.lang.String actorURI)

Creates a new SecuritySpec instance.

Parameters:

name - a String value

targetNS - a String value identifying the namespace to be used for Security elements.

actorURI - a String value identifying the the target Actor for the Security Element.

Method Detail

setRole

public void setRole(java.lang.String role)

setId

public void setId(java.lang.String id)

setNamespace

public void setNamespace(java.lang.String namespace)

setSignatureSpec

public SignatureSpec setSignatureSpec(java.lang.String canonicalizationURI,
                                      java.lang.String signatureURI)

setSignatureSpec adds a SignatureSpec to the SecuritySpec element. The SignatureSpec can be further configured using the returned instance.

Parameters:

canonicalizationURI - a String value that is URI of the canonicalization method to be used in the signature

signatureURI - a String value that is the URI of the signature method to be used for the signature.

Returns:

a SignatureSpec value

setSignatureSpec

public SignatureSpec setSignatureSpec(java.lang.String canonicalizationURI,
                                      java.lang.String signatureURI,
                                      boolean signedBody)

setSignatureSpec adds a SignatureSpec to the SecuritySpec element. The SignatureSpec can be further configured using the returned instance.

Parameters:

canonicalizationURI - a String value that is URI of the canonicalization method to be used in the signature

signatureURI - a String value that is the URI of the signature method to be used for the signature.

signedBody - indicates whether the operation should cover the SOAP Body.

Returns:

a SignatureSpec value

setSignatureSpec

public SignatureSpec setSignatureSpec(SignatureSpec spec)

setSignatureSpec adds the provided signatureSpec to this SecuritySpec

Parameters:

spec - a SignatureSpec

Returns:

setUsernameTokenSpec

public weblogic.xml.security.specs.UsernameTokenSpec setUsernameTokenSpec(java.lang.String passwordType)

setUsernameTokenSpec adds a UsernameTokenSpec to the SecuritySpec element.

Parameters:

passwordType - a String value

Returns:

an UsernameTokenSpec value

setUsernameTokenSpec

public weblogic.xml.security.specs.UsernameTokenSpec setUsernameTokenSpec(java.lang.String passwordType,
                                                                          java.lang.String realm)

setUsernameTokenSpec adds a UsernameTokenSpec to the SecuritySpec element.

Parameters:

passwordType - a String value

realm - a String value

Returns:

an UsernameTokenSpec value

setUsernameTokenSpec

public weblogic.xml.security.specs.UsernameTokenSpec setUsernameTokenSpec(weblogic.xml.security.specs.UsernameTokenSpec spec)

setUsernameTokenSpec adds a UsernameTokenSpec to the SecuritySpec element.

Parameters:

spec -

Returns:

setBinarySecurityTokenSpec

public weblogic.xml.security.specs.BinarySecurityTokenSpec setBinarySecurityTokenSpec(java.lang.String type)

addBinarySecurityTokenSpec adds a spec for a BinarySecurityTokenImpl to the SecuritySpec.

Parameters:

type - a String value indicating the type of BST to be included (i.e. X509Certificate)

Returns:

an UsernameTokenSpec value

setBinarySecurityTokenSpec

public weblogic.xml.security.specs.BinarySecurityTokenSpec setBinarySecurityTokenSpec(weblogic.xml.security.specs.BinarySecurityTokenSpec spec)

addBinarySecurityTokenSpec adds a spec for a BinarySecurityTokenImpl to the SecuritySpec.

Parameters:

spec -

Returns:

setEncryptionSpec

public EncryptionSpec setEncryptionSpec(java.lang.String encryptionURI,
                                        java.security.cert.X509Certificate cert)

addEncryptionSpec adds a spec for encrypted data to the SecuritySpec.

Parameters:

encryptionURI - a String value that is the URI of the encryption algorith to be used.

cert - a java.security.cert.X509Certificate value that is the certificate of the receiver.

Returns:

an UsernameTokenSpec value

setEncryptionSpec

public EncryptionSpec setEncryptionSpec(java.lang.String encryptionURI,
                                        java.security.cert.X509Certificate cert,
                                        boolean encryptBody)

addEncryptionSpec adds a spec for encrypted data to the SecuritySpec.

Parameters:

encryptionURI - a String value that is the URI of the encryption algorith to be used.

cert - a java.security.cert.X509Certificate value that is the certificate of the receiver.

encryptBody - indicates whether the operation should cover the entire SOAP Body.

Returns:

an UsernameTokenSpec value

setEncryptionSpec

public EncryptionSpec setEncryptionSpec(EncryptionSpec spec)

getRole

public java.lang.String getRole()

Returns the role for this SecuritySpec

Returns:

getId

public java.lang.String getId()

Returns the id for this SecuritySpec

Returns:

setEnablePasswordAuth

public void setEnablePasswordAuth(boolean enable)

enables plain text password auth for this SecuritySpec

Parameters:

enable -

getEnablePasswordAuth

public boolean getEnablePasswordAuth()

Returns whether Password based auth has been enabled for this spec.

Returns:

getSignatureSpec

public SignatureSpec getSignatureSpec()

Returns the SignatureSpec for this SecuritySpec

Returns:

getEncryptionSpec

public EncryptionSpec getEncryptionSpec()

Returns the EncryptionSpec for this SecuritySpec

Returns:

createSecurity

public final Security createSecurity(java.lang.String role,
                                     weblogic.xml.security.specs.TimestampConfig tsConfig,
                                     java.lang.String username,
                                     java.lang.String password,
                                     java.security.cert.X509Certificate encryptCert,
                                     java.security.PrivateKey sigKey,
                                     java.security.cert.X509Certificate sigCert,
                                     SecurityElementFactory factory)