com.openexchange.oauth.provider.rmi.client

Interface RemoteClientManagement

All Superinterfaces:

java.rmi.Remote

public interface RemoteClientManagement
extends java.rmi.Remote

RemoteClientManagement - The RMI stub for OAuth Client management.

Since:

v7.8.0

Author:

Thorben Betten

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_GID The default context group ID.
static java.lang.String	RMI_NAME RMI name to be used in the naming lookup.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	disableClient(java.lang.String clientId, Credentials credentials) Disables denoted client
boolean	enableClient(java.lang.String clientId, Credentials credentials) Enables denoted client
ClientDto	getClientById(java.lang.String clientId, Credentials credentials) Gets the client identified by the given identifier.
java.util.List<ClientDto>	getClients(java.lang.String contextGroup, Credentials credentials) Gets all clients for the given context group.
ClientDto	registerClient(java.lang.String contextGroup, ClientDataDto clientData, Credentials credentials) Registers (adds) a client according to given client data.
ClientDto	revokeClientSecret(java.lang.String clientId, Credentials credentials) Revokes a client's current secret and generates a new one.
boolean	unregisterClient(java.lang.String clientId, Credentials credentials) Unregisters an existing client
ClientDto	updateClient(java.lang.String clientId, ClientDataDto clientData, Credentials credentials) Updates an existing client's attributes according to given client data.

Field Detail

DEFAULT_GID

static final java.lang.String DEFAULT_GID

The default context group ID.

See Also:

Constant Field Values

RMI_NAME

static final java.lang.String RMI_NAME

RMI name to be used in the naming lookup.

Method Detail

getClients

java.util.List<ClientDto> getClients(java.lang.String contextGroup,
                                   Credentials credentials)
                                     throws RemoteClientManagementException,
                                            java.rmi.RemoteException,
                                            InvalidCredentialsException

Gets all clients for the given context group.

Parameters:

contextGroup - The context group ID. Pass DEFAULT_GID in deployments without multiple context groups.

credentials - The master admin credentials

Returns:

A list of clients

Throws:

InvalidCredentialsException - If the passed credentials are invalid

RemoteClientManagementException

java.rmi.RemoteException

getClientById

ClientDto getClientById(java.lang.String clientId,
                      Credentials credentials)
                        throws RemoteClientManagementException,
                               java.rmi.RemoteException,
                               InvalidCredentialsException

Gets the client identified by the given identifier.

Parameters:

clientId - The clients identifier

credentials - The master admin credentials

Returns:

The client or null if there is no such client

Throws:

RemoteClientManagementException - If operation fails

InvalidCredentialsException - If the passed credentials are invalid

java.rmi.RemoteException

registerClient

ClientDto registerClient(java.lang.String contextGroup,
                       ClientDataDto clientData,
                       Credentials credentials)
                         throws RemoteClientManagementException,
                                java.rmi.RemoteException,
                                InvalidCredentialsException

Registers (adds) a client according to given client data.

Parameters:

contextGroup - The context group ID. Pass DEFAULT_GID in deployments without multiple context groups.

clientData - The client data to create the client from

credentials - The master admin credentials

Returns:

The newly created client

Throws:

RemoteClientManagementException - If create operation fails

InvalidCredentialsException - If the passed credentials are invalid

java.rmi.RemoteException

updateClient

ClientDto updateClient(java.lang.String clientId,
                     ClientDataDto clientData,
                     Credentials credentials)
                       throws RemoteClientManagementException,
                              java.rmi.RemoteException,
                              InvalidCredentialsException

Updates an existing client's attributes according to given client data.

Parameters:

clientId - The client identifier

clientData - The client data

credentials - The master admin credentials

Returns:

The updated client

Throws:

RemoteClientManagementException - If update operation fails

InvalidCredentialsException - If the passed credentials are invalid

java.rmi.RemoteException

unregisterClient

boolean unregisterClient(java.lang.String clientId,
                       Credentials credentials)
                         throws RemoteClientManagementException,
                                java.rmi.RemoteException,
                                InvalidCredentialsException

Unregisters an existing client

Parameters:

clientId - The client identifier

credentials - The master admin credentials

Returns:

true if and only if such a client existed and has been successfully deleted; otherwise false

Throws:

RemoteClientManagementException - If un-registration fails

InvalidCredentialsException - If the passed credentials are invalid

java.rmi.RemoteException

revokeClientSecret

ClientDto revokeClientSecret(java.lang.String clientId,
                           Credentials credentials)
                             throws RemoteClientManagementException,
                                    java.rmi.RemoteException,
                                    InvalidCredentialsException

Revokes a client's current secret and generates a new one.

Parameters:

clientId - The client identifier

credentials - The master admin credentials

Returns:

The client with revoked/new secret

Throws:

RemoteClientManagementException - If revoke operation fails

InvalidCredentialsException - If the passed credentials are invalid

java.rmi.RemoteException

enableClient

boolean enableClient(java.lang.String clientId,
                   Credentials credentials)
                     throws RemoteClientManagementException,
                            java.rmi.RemoteException,
                            InvalidCredentialsException

Enables denoted client

Parameters:

clientId - The client identifier

credentials - The master admin credentials

Returns:

true if enabling was successful, false if the client was already enabled

Throws:

RemoteClientManagementException - If client could not be enabled

InvalidCredentialsException - If the passed credentials are invalid

java.rmi.RemoteException

disableClient

boolean disableClient(java.lang.String clientId,
                    Credentials credentials)
                      throws RemoteClientManagementException,
                             java.rmi.RemoteException,
                             InvalidCredentialsException

Disables denoted client

Parameters:

clientId - The client identifier

credentials - The master admin credentials

Returns:

true if disabling was successful, false if the client was already disabled

Throws:

RemoteClientManagementException - If client could not be disabled

InvalidCredentialsException - If the passed credentials are invalid

java.rmi.RemoteException