public interface RemoteClientManagement
extends java.rmi.Remote
RemoteClientManagement
- The RMI stub for OAuth Client management.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.
|
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.
|
static final java.lang.String DEFAULT_GID
static final java.lang.String RMI_NAME
java.util.List<ClientDto> getClients(java.lang.String contextGroup, Credentials credentials) throws RemoteClientManagementException, java.rmi.RemoteException, InvalidCredentialsException
contextGroup
- The context group ID. Pass DEFAULT_GID
in deployments without multiple context groups.credentials
- The master admin credentialsInvalidCredentialsException
- If the passed credentials are invalidRemoteClientManagementException
java.rmi.RemoteException
ClientDto getClientById(java.lang.String clientId, Credentials credentials) throws RemoteClientManagementException, java.rmi.RemoteException, InvalidCredentialsException
clientId
- The clients identifiercredentials
- The master admin credentialsnull
if there is no such clientRemoteClientManagementException
- If operation failsInvalidCredentialsException
- If the passed credentials are invalidjava.rmi.RemoteException
ClientDto registerClient(java.lang.String contextGroup, ClientDataDto clientData, Credentials credentials) throws RemoteClientManagementException, java.rmi.RemoteException, InvalidCredentialsException
contextGroup
- The context group ID. Pass DEFAULT_GID
in deployments without multiple context groups.clientData
- The client data to create the client fromcredentials
- The master admin credentialsRemoteClientManagementException
- If create operation failsInvalidCredentialsException
- If the passed credentials are invalidjava.rmi.RemoteException
ClientDto updateClient(java.lang.String clientId, ClientDataDto clientData, Credentials credentials) throws RemoteClientManagementException, java.rmi.RemoteException, InvalidCredentialsException
clientId
- The client identifierclientData
- The client datacredentials
- The master admin credentialsRemoteClientManagementException
- If update operation failsInvalidCredentialsException
- If the passed credentials are invalidjava.rmi.RemoteException
boolean unregisterClient(java.lang.String clientId, Credentials credentials) throws RemoteClientManagementException, java.rmi.RemoteException, InvalidCredentialsException
clientId
- The client identifiercredentials
- The master admin credentialstrue
if and only if such a client existed and has been successfully deleted; otherwise false
RemoteClientManagementException
- If un-registration failsInvalidCredentialsException
- If the passed credentials are invalidjava.rmi.RemoteException
ClientDto revokeClientSecret(java.lang.String clientId, Credentials credentials) throws RemoteClientManagementException, java.rmi.RemoteException, InvalidCredentialsException
clientId
- The client identifiercredentials
- The master admin credentialsRemoteClientManagementException
- If revoke operation failsInvalidCredentialsException
- If the passed credentials are invalidjava.rmi.RemoteException
boolean enableClient(java.lang.String clientId, Credentials credentials) throws RemoteClientManagementException, java.rmi.RemoteException, InvalidCredentialsException
clientId
- The client identifiercredentials
- The master admin credentialstrue
if enabling was successful, false
if the client was already enabledRemoteClientManagementException
- If client could not be enabledInvalidCredentialsException
- If the passed credentials are invalidjava.rmi.RemoteException
boolean disableClient(java.lang.String clientId, Credentials credentials) throws RemoteClientManagementException, java.rmi.RemoteException, InvalidCredentialsException
clientId
- The client identifiercredentials
- The master admin credentialstrue
if disabling was successful, false
if the client was already disabledRemoteClientManagementException
- If client could not be disabledInvalidCredentialsException
- If the passed credentials are invalidjava.rmi.RemoteException