Package org.oa4mp.server.api.admin.adminClient

Class AdminClient

java.lang.Object

edu.uiuc.ncsa.security.core.util.IdentifiableImpl

edu.uiuc.ncsa.security.storage.monitored.Monitored

org.oa4mp.delegation.common.storage.clients.BaseClient

org.oa4mp.server.api.admin.adminClient.AdminClient

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.DateComparable, edu.uiuc.ncsa.security.core.Identifiable, Serializable, Cloneable

public class AdminClient
extends org.oa4mp.delegation.common.storage.clients.BaseClient

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_NUMBER_OF_OIDC_CLIENTS	The maximum number of OIDC (i.e. standard) clients an admin client may create before being refused by the system.
static String	PUBLIC_KEY_KEY	Store in the config for this user.

Constructor Summary

Constructors

Constructor	Description
AdminClient(edu.uiuc.ncsa.security.core.Identifier identifier)

Method Summary

Modifier and Type	Method	Description
boolean	allowQDLCodeBlocks()
boolean	canInitializeFlows()
org.oa4mp.delegation.common.storage.clients.BaseClient	clone()
boolean	equals(Object obj)
net.sf.json.JSONObject	getConfig()
String	getExternalVIName()	The name, used by external applications for their VI.
URI	getIdHead()
String	getIssuer()
int	getMaxClients()	The maximum number of standard clients this admin client can create before the system refuses to accept any more.
PublicKey	getPublicKey()
edu.uiuc.ncsa.security.core.Identifier	getVirtualIssuer()
boolean	hasConfig()
boolean	hasVirtualIssuer()
boolean	isAllowCustomIDs()
boolean	isAllowQDL()
boolean	isGenerateIDs()
boolean	isListUsers()	If this client can list information about a given users tokens.
boolean	isListUsersInOtherClients()	If this client can list information about a given user's tokens from other clients.
boolean	isNotifyOnNewClientCreate()	Deprecated.
boolean	isUseTimestampInIDs()
protected void	populateClone(org.oa4mp.delegation.common.storage.clients.BaseClient client)
void	setAllowCustomIDs(boolean allowCustomIDs)
void	setAllowQDL(boolean allowQDL)
void	setAllowQDLCodeBlocks(boolean allowQDLCodeBlocks)
void	setConfig(net.sf.json.JSONObject config)
void	setExternalVIName(String externalVIName)
void	setGenerateIDs(boolean generateIDs)
void	setIdHead(URI idHead)
void	setInitializeFlows(boolean initializeFlows)
void	setIssuer(String issuer)
void	setListUsers(boolean listUsers)
void	setListUsersInOtherClients(boolean listUserInOtherClients)
void	setMaxClients(int maxClients)
void	setNotifyOnNewClientCreate(boolean notifyOnNewClientCreate)
void	setPublicKey(PublicKey publicKey)
void	setUseTimestampInIDs(boolean useTimestampInIDs)
void	setVirtualIssuer(edu.uiuc.ncsa.security.core.Identifier virtualIssuer)
String	toString()

Methods inherited from class org.oa4mp.delegation.common.storage.clients.BaseClient

getCreationTS, getEmail, getJWKS, getJwksURI, getLastModifiedTS, getName, getSecret, getServiceClientUsers, hasJWKS, hasJWKSURI, hasServiceClientUsers, isDebugOn, isServiceClient, setCreationTS, setDebugOn, setEmail, setJWKS, setJwksURI, setLastModifiedTS, setName, setSecret, setServiceClient, setServiceClientUsers

Methods inherited from class edu.uiuc.ncsa.security.storage.monitored.Monitored

getLastAccessed, setLastAccessed

Methods inherited from class edu.uiuc.ncsa.security.core.util.IdentifiableImpl

getDescription, getIdentifier, getIdentifierString, isReadOnly, setDescription, setIdentifier, setReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MAX_NUMBER_OF_OIDC_CLIENTS

public static int DEFAULT_MAX_NUMBER_OF_OIDC_CLIENTS

The maximum number of OIDC (i.e. standard) clients an admin client may create before being refused by the system. This is to prevent error (e.g. an admin client is used in a script which is misbehaving). This may be increased and is simply the default for newly created admin clients.

PUBLIC_KEY_KEY

public static String PUBLIC_KEY_KEY

Store in the config for this user. This will be used for secure communication.

Constructor Detail

AdminClient

public AdminClient(edu.uiuc.ncsa.security.core.Identifier identifier)

Method Detail

getPublicKey

public PublicKey getPublicKey()
                       throws InvalidKeySpecException,
                              NoSuchAlgorithmException

Throws:

InvalidKeySpecException

NoSuchAlgorithmException

setPublicKey

public void setPublicKey(PublicKey publicKey)

hasConfig

public boolean hasConfig()

getIssuer

public String getIssuer()

setIssuer

public void setIssuer(String issuer)

getExternalVIName

public String getExternalVIName()

The name, used by external applications for their VI. These names have nothing to do with OA4MP's virtual issuer mechanisms and are typically just displayed to the user at some point. Normally these are identical to the id of the VI, but might be different.

Returns:

setExternalVIName

public void setExternalVIName(String externalVIName)

getVirtualIssuer

public edu.uiuc.ncsa.security.core.Identifier getVirtualIssuer()

setVirtualIssuer

public void setVirtualIssuer(edu.uiuc.ncsa.security.core.Identifier virtualIssuer)

hasVirtualIssuer

public boolean hasVirtualIssuer()

getConfig

public net.sf.json.JSONObject getConfig()

setConfig

public void setConfig(net.sf.json.JSONObject config)

getMaxClients

public int getMaxClients()

The maximum number of standard clients this admin client can create before the system refuses to accept any more.

Returns:

setMaxClients

public void setMaxClients(int maxClients)

equals

public boolean equals(Object obj)

Overrides:

equals in class org.oa4mp.delegation.common.storage.clients.BaseClient

clone

public org.oa4mp.delegation.common.storage.clients.BaseClient clone()

Specified by:

clone in interface edu.uiuc.ncsa.security.core.Identifiable

Overrides:

clone in class org.oa4mp.delegation.common.storage.clients.BaseClient

populateClone

protected void populateClone(org.oa4mp.delegation.common.storage.clients.BaseClient client)

Overrides:

populateClone in class org.oa4mp.delegation.common.storage.clients.BaseClient

isAllowQDL

public boolean isAllowQDL()

setAllowQDL

public void setAllowQDL(boolean allowQDL)

allowQDLCodeBlocks

public boolean allowQDLCodeBlocks()

setAllowQDLCodeBlocks

public void setAllowQDLCodeBlocks(boolean allowQDLCodeBlocks)

toString

public String toString()

Overrides:

toString in class org.oa4mp.delegation.common.storage.clients.BaseClient

isNotifyOnNewClientCreate

public boolean isNotifyOnNewClientCreate()

Deprecated.

CIL-607 required a better way to do this for more than new client notifications. Use BaseClient.isDebugOn() instead.

Returns:

setNotifyOnNewClientCreate

public void setNotifyOnNewClientCreate(boolean notifyOnNewClientCreate)

isListUsers

public boolean isListUsers()

If this client can list information about a given users tokens.

Returns:

setListUsers

public void setListUsers(boolean listUsers)

isListUsersInOtherClients

public boolean isListUsersInOtherClients()

If this client can list information about a given user's tokens from other clients. This implies that isListUsers() is true.

Returns:

setListUsersInOtherClients

public void setListUsersInOtherClients(boolean listUserInOtherClients)

isAllowCustomIDs

public boolean isAllowCustomIDs()

setAllowCustomIDs

public void setAllowCustomIDs(boolean allowCustomIDs)

isGenerateIDs

public boolean isGenerateIDs()

setGenerateIDs

public void setGenerateIDs(boolean generateIDs)

getIdHead

public URI getIdHead()

setIdHead

public void setIdHead(URI idHead)

isUseTimestampInIDs

public boolean isUseTimestampInIDs()

setUseTimestampInIDs

public void setUseTimestampInIDs(boolean useTimestampInIDs)

canInitializeFlows

public boolean canInitializeFlows()

setInitializeFlows

public void setInitializeFlows(boolean initializeFlows)