Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

weblogic.security.providers.authentication
Interface VirtualUserAuthenticatorMBean

All Superinterfaces:
AuthenticationProviderMBean, AuthenticatorMBean, DescriptorBean, ProviderMBean, SettableBean, StandardInterface

public interface VirtualUserAuthenticatorMBean
extends StandardInterface, DescriptorBean, AuthenticatorMBean

The MBean that represents configuration attributes for the Virtual User Authentication provider. The Virtual User Authentication provider enables Weblogic Server to authenticate users based on Identity Assertion only. That is, authenticated virtual users are not found in the user store, and all principals and credentials are derived from the given token.

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 getControlFlag()
          The control flag determining how the login sequence uses the Virtual User Authentication provider.
 String getDescription()
          A short description of the Virtual User Authentication provider.
 String getName()
          The name of this configuration.
 String getProviderClassName()
          The name of the Java class used to load the Virtual User Authentication provider.
 String getVersion()
          The version number of the Virtual User Authentication provider.
 void setControlFlag(String newValue)
          The control flag determining how the login sequence uses the Virtual User Authentication provider.
 
Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
 
Methods inherited from interface weblogic.descriptor.SettableBean
isSet, unSet
 
Methods inherited from interface weblogic.management.security.ProviderMBean
getRealm
 
Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
 
Methods inherited from interface weblogic.descriptor.SettableBean
isSet, unSet
 

Method Detail

getProviderClassName

String getProviderClassName()

The name of the Java class used to load the Virtual User Authentication provider.

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

getDescription

String getDescription()

A short description of the Virtual User Authentication provider.

Specified by:
getDescription in interface ProviderMBean
Default Value:
"The Virtual User Authentication provider authenticates users based on the identity assertion token only, independent of a user store."

getVersion

String getVersion()

The version number of the Virtual User Authentication provider.

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

getControlFlag

String getControlFlag()

The control flag determining how the login sequence uses the Virtual User Authentication provider.

Specified by:
getControlFlag in interface AuthenticatorMBean
Default Value:
"SUFFICIENT"
Valid Values:
"REQUIRED","REQUISITE","SUFFICIENT","OPTIONAL"

setControlFlag

void setControlFlag(String newValue)
                    throws InvalidAttributeValueException

The control flag determining how the login sequence uses the Virtual User Authentication provider.

Specified by:
setControlFlag in interface AuthenticatorMBean
Parameters:
newValue - - new value for attribute ControlFlag
Throws:
InvalidAttributeValueException
See Also:
AuthenticatorMBean.getControlFlag()
Default Value:
"SUFFICIENT"
Valid Values:
"REQUIRED","REQUISITE","SUFFICIENT","OPTIONAL"

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
Specified by:
getName in interface StandardInterface
Default Value:
"VirtualUserAuthenticator"

Copyright 1996, 2014, 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
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02