Package com.redwood.scheduler.api.model

Interface CredentialVault

All Superinterfaces:

ApplicationObject, BusinessKeyObject, CredentialVaultComp, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Root, SchedulerEntity, SchedulerEntityComp, UniqueNamedApplicationObject

public interface CredentialVault
extends CredentialVaultComp, UniqueNamedApplicationObject

This points to an instance of a CredentialProvider, e.g. CyberArk_Finance.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "CredentialVault" objects.
static String	SEC_PRIV_CREATE	This privilege can be granted at a group level.
static String	SEC_PRIV_DELETE	This privilege can be granted at a group level.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_PRIV_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , edit , delete
static String	SEC_RANK_CREATE	This rank is made of the following privileges: create
static String	SEC_RANK_DELETE	This rank is made of the following privileges: create , view , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<CredentialVault>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
RequiredPermission	checkCreatePrivilege()	Check whether or not the create action can be performed on this object.
RequiredPermission	checkDeletePrivilege()	Check whether or not the delete action can be performed on this object.
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
CredentialVaultParameter	createCredentialVaultParameter(CredentialProviderParameter newCredentialProviderParameter)	Create a new CredentialVaultParameter linked to this object.
CredentialProvider	getCredentialProvider()	Get the CredentialProvider.
CredentialVaultParameter	getCredentialVaultParameterByCredentialProviderParameter(CredentialProviderParameter credentialProviderParameter)	Get the CredentialVaultParameter by CredentialProviderParameter.
CredentialVaultParameter	getCredentialVaultParameterByName(String parameterName)	Return the JobParameter for the given name.
RWIterable<CredentialVaultParameter>	getCredentialVaultParameters()	Get an RWIterable over an ordered collection of CredentialVaultParameters.
void	setCredentialProvider(CredentialProvider newCredentialProvider)	Set the value for CredentialProvider.

Methods inherited from interface com.redwood.scheduler.api.model.ApplicationObject

getParentApplication, setParentApplication

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.PartitionableObject

createObjectTag, getEditablePartitions, getObjectTagByObjectTagDefinition, getObjectTags, getPartition, setPartition

Methods inherited from interface com.redwood.scheduler.api.model.Root

getCreationTime, getLastModificationTime, getLastModifierSubject

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "CredentialVault" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<CredentialVault> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_PRIV_CREATE

static final String SEC_PRIV_CREATE

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_DELETE

static final String SEC_PRIV_DELETE

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_CREATE

static final String SEC_RANK_CREATE

This rank is made of the following privileges: create

See Also:

Constant Field Values

SEC_RANK_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , edit

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: create , view , delete

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: create , view , edit , delete

See Also:

Constant Field Values

Method Detail

getCredentialVaultParameterByName

CredentialVaultParameter getCredentialVaultParameterByName(String parameterName)

Return the JobParameter for the given name. The name is taken from the JobDefinitionParameter

Parameters:

parameterName - The name of the CredentialVaultParameter

Returns:

The CredentialVaultParameter for the given name, null if the parameter with that name could not be found

getCredentialProvider

CredentialProvider getCredentialProvider()

Get the CredentialProvider.

Returns:

CredentialProvider

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

ObjectNotAttachedToSessionException - If this method is called when the object has been removed from its session.

setCredentialProvider

void setCredentialProvider(CredentialProvider newCredentialProvider)

Set the value for CredentialProvider. This value is mandatory.

Parameters:

newCredentialProvider - is the object to set CredentialProvider to. The Credential Provider of a CredentialVault. The Credential Provider defines what type of vault it is. The Credential Vault is a real instance of such a CredentialProvider. If this is null, then the object cannot be persisted.

getCredentialVaultParameters

RWIterable<CredentialVaultParameter> getCredentialVaultParameters()

Get an RWIterable over an ordered collection of CredentialVaultParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. CredentialVaultParameters are used to configure the CredentialVault, including where the vault resides and how to connect to it.

Specified by:

getCredentialVaultParameters in interface CredentialVaultComp

Returns:

An RWIterable over an ordered collection of CredentialVaultParameter objects .

createCredentialVaultParameter

CredentialVaultParameter createCredentialVaultParameter(CredentialProviderParameter newCredentialProviderParameter)

Create a new CredentialVaultParameter linked to this object.

Parameters:

newCredentialProviderParameter - The other parent of the CredentialVaultParameterCredentialProviderParameter association.

Returns:

a new CredentialVaultParameter.

getCredentialVaultParameterByCredentialProviderParameter

CredentialVaultParameter getCredentialVaultParameterByCredentialProviderParameter(CredentialProviderParameter credentialProviderParameter)

Get the CredentialVaultParameter by CredentialProviderParameter.

Parameters:

credentialProviderParameter -

Returns:

the CredentialVaultParameter, or null if it could not be found

checkCreatePrivilege

RequiredPermission checkCreatePrivilege()

Check whether or not the create action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkViewPrivilege

RequiredPermission checkViewPrivilege()

Check whether or not the view action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkDeletePrivilege

RequiredPermission checkDeletePrivilege()

Check whether or not the delete action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.