weblogic.security.providers.authentication
Interface WindowsNTAuthenticatorMBean

All Superinterfaces:

AuthenticationProviderMBean, AuthenticatorMBean, GroupReaderMBean, ListerMBean, MemberGroupListerMBean, NameListerMBean, ProviderMBean, UserReaderMBean

public interface WindowsNTAuthenticatorMBean
extends AuthenticatorMBean, UserReaderMBean, GroupReaderMBean, MemberGroupListerMBean

This MBean contains configuration information for the Windows NT Authetication Provider

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.

getProviderClassName

String getProviderClassName()

The name of the Java class used to load the Windows NT Authentication provider.

Default Value:

"weblogic.security.providers.authentication.NTAuthenticatorProviderImpl"

getDescription

String getDescription()

The Windows NT Authentication provider enables Windows NT users and groups to be used for authentication purposes.

Specified by:

getDescription in interface ProviderMBean

Default Value:

"Provider that performs Windows NT Authentication"

getVersion

String getVersion()

The version number of the Windows NT Authentication provider.

Specified by:

getVersion in interface ProviderMBean

Default Value:

"1.0"

getDomainControllers

String getDomainControllers()

The domain controllers used for locating unscoped usernames during authentication, listing users/groups, and handling unscoped names.

Possible settings:

• Local--local machine only.
• LocalAndDomain--the local machine and the domain in which the machine is a member (if it is not standalone).
• Domain--the domain in which the machine is a member.
• List--Use the domain controllers specified in the Domain Controller List setting.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"LocalAndDomain"

Valid Values:

"Local","LocalAndDomain","Domain","List"

setDomainControllers

void setDomainControllers(String newValue)
                          throws InvalidAttributeValueException

The domain controllers used for locating unscoped usernames during authentication, listing users/groups, and handling unscoped names.

Possible settings:

• Local--local machine only.
• LocalAndDomain--the local machine and the domain in which the machine is a member (if it is not standalone).
• Domain--the domain in which the machine is a member.
• List--Use the domain controllers specified in the Domain Controller List setting.

Parameters:

newValue - - new value for attribute DomainControllers

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"LocalAndDomain"

Valid Values:

"Local","LocalAndDomain","Domain","List"

getDomainControllerList

String[] getDomainControllerList()

A list of the domain controllers used for locating unscoped usernames during authentication, listing users/groups, and handling unscoped names. Use if the Domain Controllers is set to List.

The specified list should contain the domain controller names in trusted domains. Placeholders are supported and will expand if specified. Supported placeholders are [Local],[LocalAndDomain], [Domain].

Changes take effect after you redeploy the module or restart the server.

Default Value:

"[LocalAndDomain]"

setDomainControllerList

void setDomainControllerList(String[] newValue)
                             throws InvalidAttributeValueException

A list of the domain controllers used for locating unscoped usernames during authentication, listing users/groups, and handling unscoped names. Use if the Domain Controllers is set to List.

The specified list should contain the domain controller names in trusted domains. Placeholders are supported and will expand if specified. Supported placeholders are [Local],[LocalAndDomain], [Domain].

Parameters:

newValue - - new value for attribute DomainControllerList

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"[LocalAndDomain]"

getBadDomainControllerRetry

String getBadDomainControllerRetry()

Determines how the provider reacts when a bad domain controller name is found.

Possible settings:

• Delay indicates the domain controller can be used again only after a certain amount of time has elapsed since it was last tried unsuccessfully.
• Never indicates a bad domain controller is never retried.
• Always indicates a bad domain controller is always retried.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"Delay"

Valid Values:

"Delay","Never","Always"

setBadDomainControllerRetry

void setBadDomainControllerRetry(String newValue)
                                 throws InvalidAttributeValueException

Determines how the provider reacts when a bad domain controller name is found.

Possible settings:

• Delay indicates the domain controller can be used again only after a certain amount of time has elapsed since it was last tried unsuccessfully.
• Never indicates a bad domain controller is never retried.
• Always indicates a bad domain controller is always retried.

Parameters:

newValue - - new value for attribute BadDomainControllerRetry

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"Delay"

Valid Values:

"Delay","Never","Always"

getBadDomainControllerRetryInterval

Integer getBadDomainControllerRetryInterval()

This time to wait when a bad domain controller name is found before trying to use the domain controller again. Use if the BadDomainControllerRetry is set to Delay. This setting helps reduce performance hits when a domain controller in the list of controllers is temporarily unavailable.

Changes take effect after you redeploy the module or restart the server.

Default Value:

new Integer(60000)

setBadDomainControllerRetryInterval

void setBadDomainControllerRetryInterval(Integer newValue)
                                         throws InvalidAttributeValueException

This time to wait when a bad domain controller name is found before trying to use the domain controller again. Use if the BadDomainControllerRetry is set to Delay. This setting helps reduce performance hits when a domain controller in the list of controllers is temporarily unavailable.

Parameters:

newValue - - new value for attribute BadDomainControllerRetryInterval

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

new Integer(60000)

getMapUPNNames

String getMapUPNNames()

Indicates how the Windows NT Authentication provider should map UPN-style names for authentication (meaning will username@domain be used).

Possible settings:

• First--names which match the UPN format should be treated as a UPN name first. If the name isn't a UPN name, the name will be treated as an unscoped name.
• Last--names which match the UPN format should be treated as a UPN name only if the name failed to be matched as an unscoped name.
• Always--names which match the UPN format will always be treated as a UPN name.

This setting should only be used when there are no usernames with @. domain\\username is not ambiguous and is always allowed.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"First"

Valid Values:

"First","Last","Always","Never"

setMapUPNNames

void setMapUPNNames(String newValue)
                    throws InvalidAttributeValueException

Indicates how the Windows NT Authentication provider should map UPN-style names for authentication (meaning will username@domain be used).

Possible settings:

• First--names which match the UPN format should be treated as a UPN name first. If the name isn't a UPN name, the name will be treated as an unscoped name.
• Last--names which match the UPN format should be treated as a UPN name only if the name failed to be matched as an unscoped name.
• Always--names which match the UPN format will always be treated as a UPN name.

This setting should only be used when there are no usernames with @. domain\\username is not ambiguous and is always allowed.

Parameters:

newValue - - new value for attribute MapUPNNames

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"First"

Valid Values:

"First","Last","Always","Never"

getLogonType

String getLogonType()

Specifies whether the logon process should use Network or Interactive logon.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"Interactive"

Valid Values:

"Interactive","Network"

setLogonType

void setLogonType(String newValue)
                  throws InvalidAttributeValueException

Specifies whether the logon process should use Network or Interactive logon.

Parameters:

newValue - - new value for attribute LogonType

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"Interactive"

Valid Values:

"Interactive","Network"

getMapNTDomainName

String getMapNTDomainName()

Specifies whether the Windows NT domain information should be placed into principal names during authentication.

Possible settings:

• Never--the Windows NT domain name is not placed in the principal names.
• OldUPN--the Windows NT domain name is placed in the principal names as domain\\name.
• UPN-- the Windows NT domain name is placed in the principal names as name@domain.

Changes take effect after you redeploy the module or restart the server.

Default Value:

"Never"

Valid Values:

"OldUPN","UPN","Never"

setMapNTDomainName

void setMapNTDomainName(String newValue)
                        throws InvalidAttributeValueException

Specifies whether the Windows NT domain information should be placed into principal names during authentication.

Possible settings:

• Never--the Windows NT domain name is not placed in the principal names.
• OldUPN--the Windows NT domain name is placed in the principal names as domain\\name.
• UPN-- the Windows NT domain name is placed in the principal names as name@domain.

Parameters:

newValue - - new value for attribute MapNTDomainName

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

"Never"

Valid Values:

"OldUPN","UPN","Never"

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:

"WindowsNTAuthenticator"