Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

weblogic.security.providers.authentication
Interface LDAPX509IdentityAsserterMBean

All Superinterfaces:
AuthenticationProviderMBean, IdentityAsserterMBean, LDAPServerMBean, ProviderMBean
public interface LDAPX509IdentityAsserterMBean
extends IdentityAsserterMBean, LDAPServerMBean

The MBean that represents configuration atrributes for the WebLogic LDAP X509 Identity Assertion provider. The WebLogic LDAP X509 Identity Assertion provider supports certificate authentication.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.

Method Summary
 String[] getActiveTypes()
          The token types that are currently active.
 String getCertificateAttribute()
          The name of the LDAP attribute representing the user's identity.
 String getCertificateMapping()
          Mapping of certificate attributes to directory attributes.
 String getCredential()
          The credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.
 byte[] getCredentialEncrypted()
          Returns the credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.
 String getDescription()
          A short description of the WebLogic LDAP X509 Identity Assertion provider.
 String getName()
          The name of this configuration.
 String getProviderClassName()
          The name of the Java class used to load the WebLogic LDAP X509 Identity Assertion provider.
 String[] getSupportedTypes()
          The token types supported by the WebLogic LDAP X509 Identity Assertion provider.
 String[] getUserFilterAttributes()
          The name of the certificate attribute from the subject DN used to find the user in the directory.
 String getUsernameAttribute()
          The name of the LDAP attribute used to assert the user's identity.
 String getVersion()
          The version number of the WebLogic LDAP X509 Identity Assertion provider.
 void setActiveTypes(String[] newValue)
          The token types that are currently active.
 void setCertificateAttribute(String newValue)
          The name of the LDAP attribute representing the user's identity.
 void setCertificateMapping(String newValue)
          Mapping of certificate attributes to directory attributes.
 void setCredential(String newValue)
          The credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.
 void setCredentialEncrypted(byte[] _bytes)
          Sets the credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.
 void setUserFilterAttributes(String[] newValue)
          The name of the certificate attribute from the subject DN used to find the user in the directory.
 void setUsernameAttribute(String newValue)
          The name of the LDAP attribute used to assert the user's identity.
 
Methods inherited from interface weblogic.management.security.authentication.IdentityAsserterMBean
getBase64DecodingRequired, setBase64DecodingRequired
 
Methods inherited from interface weblogic.management.security.ProviderMBean
getRealm
 
Methods inherited from interface weblogic.management.utils.LDAPServerMBean
getCacheSize, getCacheTTL, getConnectionPoolSize, getConnectionRetryLimit, getConnectTimeout, getHost, getParallelConnectDelay, getPort, getPrincipal, getResultsTimeLimit, isBindAnonymouslyOnReferrals, isCacheEnabled, isFollowReferrals, isSSLEnabled, setBindAnonymouslyOnReferrals, setCacheEnabled, setCacheSize, setCacheTTL, setConnectionPoolSize, setConnectionRetryLimit, setConnectTimeout, setFollowReferrals, setHost, setParallelConnectDelay, setPort, setPrincipal, setResultsTimeLimit, setSSLEnabled
 

Method Detail

getProviderClassName

String getProviderClassName()

The name of the Java class used to load the WebLogic LDAP X509 Identity Assertion provider.

Default Value:
"weblogic.security.providers.authentication.LDAPX509IdentityAsserterProviderImpl"

getDescription

String getDescription()

A short description of the WebLogic LDAP X509 Identity Assertion provider.

Specified by:
getDescription in interface ProviderMBean
Default Value:
"Provider that performs identity assertion for X.509 certificates"

getVersion

String getVersion()

The version number of the WebLogic LDAP X509 Identity Assertion provider.

Specified by:
getVersion in interface ProviderMBean
Default Value:
"1.0"

getSupportedTypes

String[] getSupportedTypes()

The token types supported by the WebLogic LDAP X509 Identity Assertion provider.

Specified by:
getSupportedTypes in interface IdentityAsserterMBean
Default Value:
weblogic.security.spi.IdentityAsserter.X509_TYPE

getActiveTypes

String[] getActiveTypes()

The token types that are currently active.

Specified by:
getActiveTypes in interface IdentityAsserterMBean
Default Value:
weblogic.security.spi.IdentityAsserter.X509_TYPE

setActiveTypes

void setActiveTypes(String[] newValue)
                    throws InvalidAttributeValueException

The token types that are currently active.

Specified by:
setActiveTypes in interface IdentityAsserterMBean
Parameters:
newValue - - new value for attribute ActiveTypes
Throws:
InvalidAttributeValueException
See Also:
IdentityAsserterMBean.getActiveTypes()
Default Value:
weblogic.security.spi.IdentityAsserter.X509_TYPE

getUserFilterAttributes

String[] getUserFilterAttributes()

The name of the certificate attribute from the subject DN used to find the user in the directory.

Default Value:
"cn=$subj.cn"

setUserFilterAttributes

void setUserFilterAttributes(String[] newValue)
                             throws InvalidAttributeValueException

The name of the certificate attribute from the subject DN used to find the user in the directory.

Parameters:
newValue - - new value for attribute UserFilterAttributes
Throws:
InvalidAttributeValueException
Default Value:
"cn=$subj.cn"

getUsernameAttribute

String getUsernameAttribute()

The name of the LDAP attribute used to assert the user's identity.

Default Value:
"cn"

setUsernameAttribute

void setUsernameAttribute(String newValue)
                          throws InvalidAttributeValueException

The name of the LDAP attribute used to assert the user's identity.

Parameters:
newValue - - new value for attribute UsernameAttribute
Throws:
InvalidAttributeValueException
Default Value:
"cn"

getCertificateAttribute

String getCertificateAttribute()

The name of the LDAP attribute representing the user's identity.

Default Value:
"userCertificate;binary"

setCertificateAttribute

void setCertificateAttribute(String newValue)
                             throws InvalidAttributeValueException

The name of the LDAP attribute representing the user's identity.

Parameters:
newValue - - new value for attribute CertificateAttribute
Throws:
InvalidAttributeValueException
Default Value:
"userCertificate;binary"

getCertificateMapping

String getCertificateMapping()

Mapping of certificate attributes to directory attributes.

Default Value:
"ou=people,ou=$subj.ou,o=$subj.o,c=$subj.c"

setCertificateMapping

void setCertificateMapping(String newValue)
                           throws InvalidAttributeValueException

Mapping of certificate attributes to directory attributes.

Parameters:
newValue - - new value for attribute CertificateMapping
Throws:
InvalidAttributeValueException
Default Value:
"ou=people,ou=$subj.ou,o=$subj.o,c=$subj.c"

getCredential

String getCredential()

The credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.

Specified by:
getCredential in interface LDAPServerMBean
See Also:
LDAPServerMBean.getCredentialEncrypted()
Changes take effect after you redeploy the module or restart the server.

setCredential

void setCredential(String newValue)
                   throws InvalidAttributeValueException

The credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.

Specified by:
setCredential in interface LDAPServerMBean
Parameters:
newValue - - new value for attribute Credential
Throws:
InvalidAttributeValueException
See Also:
LDAPServerMBean.getCredential(), LDAPServerMBean.setCredentialEncrypted(byte[])
Changes take effect after you redeploy the module or restart the server.

getName

String getName()
Description copied from interface: ProviderMBean
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:
getName in interface ProviderMBean
Default Value:
"LDAPX509IdentityAsserter"

setCredentialEncrypted

void setCredentialEncrypted(byte[] _bytes)
Description copied from interface: LDAPServerMBean
Sets the credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.

Specified by:
setCredentialEncrypted in interface LDAPServerMBean
Parameters:
_bytes - The new credential value as a byte array.
See Also:
LDAPServerMBean.getCredentialEncrypted()
Changes take effect after you redeploy the module or restart the server.

getCredentialEncrypted

byte[] getCredentialEncrypted()
Description copied from interface: LDAPServerMBean
Returns the credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.

Specified by:
getCredentialEncrypted in interface LDAPServerMBean
Returns:
The credential value as an encrypted byte array.
Changes take effect after you redeploy the module or restart the server.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Documentation is available at
http://download.oracle.com/docs/cd/E12839_01/web.1111/wls.htm
Copyright 1996, 2009, 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 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD