com.rim.platform.mdm.core.plugin.bws.service

Class BWSUtilService

Object

BWSUtilService

@Service
public class BWSUtilService
extends Object

Utility Web Services

Constructor Summary

Constructors

Constructor and Description
BWSUtilService()
BWSUtilService(ControllerPostConstruct controllerPostConstruct, ITenantRepository tenantRepository)

Method Summary

Methods

Modifier and Type	Method and Description
GetAuthenticatorsResponse	getAuthenticators(GetAuthenticatorsRequest request) Retrieve a list of the types of authentication that administrators can use to access the administration service.
GetEncodedUsernameResponse	getEncodedUsername(GetEncodedUsernameRequest request) Retrieve and encode the login information that is used to access the administration service.
GetLocalesResponse	getLocales(GetLocalesRequest request) Retrieve a list of the locales that the server supports.

Methods inherited from class Object

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

Constructor Detail

BWSUtilService

public BWSUtilService()

BWSUtilService

public BWSUtilService(ControllerPostConstruct controllerPostConstruct,
              ITenantRepository tenantRepository)

Method Detail

getAuthenticators

public GetAuthenticatorsResponse getAuthenticators(GetAuthenticatorsRequest request)

Retrieve a list of the types of authentication that administrators can use to access the administration service.

Request:

metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.

Response:

Contains the types of authentication that administrators can use to access the administration service.

Error codes specific to this API:

There are no error codes specific to this API.
Error codes common to all APIs.

Impact (immediate or queued):

Immediate.

getEncodedUsername

public GetEncodedUsernameResponse getEncodedUsername(GetEncodedUsernameRequest request)

Retrieve and encode the login information that is used to access the administration service.

Request:

metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
username - User's login name.
domain - The domain in which the user belongs to, not used when using BAS authentication.
authenticator - Use getAuthenticators() API to retrieve the proper authenticator.
credentialType - The method used for supplying credentials. Only PASSWORD authentication is permitted.
orgUid - Deprecated. Use the organizationUid in the request metadata instead to replace this deprecated field.

Response:

Contains the encoded string of login information that is used to access the administration service.

Error codes specific to this API:

There are no error codes specific to this API.
Error codes common to all APIs.

Impact (immediate or queued):

Immediate.

getLocales

public GetLocalesResponse getLocales(GetLocalesRequest request)

Retrieve a list of the locales that the server supports.

Request:

metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.

Response:

Contains the results for locales that are supported by the server.

Error codes specific to this API:

There are no error codes specific to this API.
Error codes common to all APIs.

Impact (immediate or queued):

Immediate.