Package com.bloomberglp.blpapi

Interface Identity

All Known Subinterfaces:

UserHandle

public interface Identity

Provides access to the services and the entitlements for a specific user.

An unauthorized Identity is created using AbstractSession.createIdentity(). Once a Identity has been created it can be authorized using sendAuthorizationRequest(). The authorized Identity can then be used in subscribe() or sendRequest() calls. Once authorized a Identity has access to the entitlements of the user which it was validated for and can then be queried to see if a user is entitled to receive data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Identity.SeatType	Seat type enumeration defines seat type values such as whether this identity is a Bloomberg Professional Service user.

Method Summary

Modifier and Type	Method	Description
boolean	hasEntitlements(int[] entitlements, Service service)	Return true if this Identity is authorized for the specified service and for each of the entitlement IDs contained in the specified entitlements.
boolean	hasEntitlements(int[] entitlements, Service service, List<Integer> failedEntitlements)	Return true if this Identity is authorized for the specified service and for each of the entitlement IDs contained in the specified entitlements.
boolean	hasEntitlements(Element entitlements, Service service)	Return true if this Identity is authorized for the specified service and for the specified entitlements.
boolean	hasEntitlements(Element entitlements, Service service, List<Integer> failedEntitlements)	Return true if this Identity is authorized for the specified service and for the specified entitlements.
boolean	isAuthorized(Service service)	Return true if the user handle is authorized for the specified service
Identity.SeatType	seatType()	Return Seat Type value of this identity.

Method Details

isAuthorized

boolean isAuthorized(Service service)

Return true if the user handle is authorized for the specified service

hasEntitlements

boolean hasEntitlements(int[] entitlements,
 Service service)

Return true if this Identity is authorized for the specified service and for each of the entitlement IDs contained in the specified entitlements.

Same as calling hasEntitlements(int[], Service, null

hasEntitlements

boolean hasEntitlements(int[] entitlements,
 Service service,
 List<Integer> failedEntitlements)

Return true if this Identity is authorized for the specified service and for each of the entitlement IDs contained in the specified entitlements.

If the optional failedEntitlements is not null then the failedEntitlements list is populated with all entitlement ids of the specified Service that this Identity doesn't have.

hasEntitlements

boolean hasEntitlements(Element entitlements,
 Service service)

Return true if this Identity is authorized for the specified service and for the specified entitlements.

Same as calling hasEntitlements(Element, service, null

hasEntitlements

boolean hasEntitlements(Element entitlements,
 Service service,
 List<Integer> failedEntitlements)

Return true if this Identity is authorized for the specified service and for the specified entitlements.

If the optional failedEntitlements is not null then the failedEntitlements list is populated with all entitlement ids of the specified Service that this Identity doesn't have.

seatType

Identity.SeatType seatType()

Return Seat Type value of this identity.