com.bloomberglp.blpapi

Class AuthOptions

java.lang.Object

com.bloomberglp.blpapi.AuthOptions

public class AuthOptions
extends Object

This class defines the authorization options which the user can set on SessionOptions as the authorization options for the session identity or use to authorize other identities.

Constructor Summary

Constructors

Constructor and Description
AuthOptions() Creates an AuthOptions to specify no authorization should be used.
AuthOptions(AuthApplication application) Creates an AuthOptions object for Application Mode.
AuthOptions(AuthToken token) Creates an AuthOptions object for Manual Token Mode.
AuthOptions(AuthUser user) Creates an AuthOptions object for User Mode with the Operating System Login(Domain\User), Active Directory, or Email.
AuthOptions(AuthUser user, AuthApplication application) Creates an AuthOptions object for User and Application Mode.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthOptions

public AuthOptions()

Creates an AuthOptions to specify no authorization should be used.

AuthOptions

public AuthOptions(AuthUser user)

Creates an AuthOptions object for User Mode with the Operating System Login(Domain\User), Active Directory, or Email. The behavior is undefined when user is null or created with AuthUser.createWithManualOptions(String, String).

Parameters:

user - user-specific authorization option.

AuthOptions

public AuthOptions(AuthApplication application)

Creates an AuthOptions object for Application Mode. The behavior is undefined when application is null.

Parameters:

application - application-specific authorization option.

AuthOptions

public AuthOptions(AuthUser user,
                   AuthApplication application)

Creates an AuthOptions object for User and Application Mode. The behavior is undefined when either user or application is null.

Parameters:

user - user-specific authorization option.

application - application-specific authorization option.

AuthOptions

public AuthOptions(AuthToken token)

Creates an AuthOptions object for Manual Token Mode. The behavior is undefined when token is null.

Parameters:

token - manually generated token.