Package com.redwood.scheduler.api.model
Interface CredentialProvider
-
- All Superinterfaces:
ApplicationObject,BusinessKeyObject,CredentialProviderComp,NamedRootObject,NamedRootObjectComp,PartitionableObject,PartitionableObjectComp,Root,SchedulerEntity,SchedulerEntityComp,UniqueNamedApplicationObject
public interface CredentialProvider extends CredentialProviderComp, UniqueNamedApplicationObject
This defines the type of an external credential vault. E.g. CyberArk or AWS.
-
-
Field Summary
Fields Modifier and Type Field Description static StringOBJECT_TYPEString that will be returned fromSchedulerEntity.getObjectType()for "CredentialProvider" objects.static StringSEC_RANK_ALLThis rank is made of the following privileges:static StringSEC_RANK_NONEThis rank has no privileges assigned to it.static QueryObjectType<CredentialProvider>TYPEType that can be used inSchedulerSession.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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CredentialProviderParametercreateCredentialProviderParameter()Create a newCredentialProviderParameterlinked to this object.CredentialProviderParametergetCredentialProviderParameterByName(String name)Get the CredentialProviderParameter by CredentialProvider.RWIterable<CredentialProviderParameter>getCredentialProviderParameters()Get anRWIterableover an ordered collection ofCredentialProviderParameters.-
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 fromSchedulerEntity.getObjectType()for "CredentialProvider" objects.- See Also:
- Constant Field Values
-
TYPE
static final QueryObjectType<CredentialProvider> TYPE
Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
-
SEC_RANK_NONE
static final String SEC_RANK_NONE
This rank has no privileges assigned to it.- See Also:
- Constant Field Values
-
SEC_RANK_ALL
static final String SEC_RANK_ALL
This rank is made of the following privileges:- See Also:
- Constant Field Values
-
-
Method Detail
-
getCredentialProviderParameters
RWIterable<CredentialProviderParameter> getCredentialProviderParameters()
Get anRWIterableover an ordered collection ofCredentialProviderParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Parameter definitions on a Credential Provider, used by a CredentialVault to create CredentialVaultParameters. These CredentialVaultParameters are used to configure the CredentialVault, including where the vault resides and how to connect to it.- Specified by:
getCredentialProviderParametersin interfaceCredentialProviderComp- Returns:
- An
RWIterableover an ordered collection ofCredentialProviderParameterobjects .
-
createCredentialProviderParameter
CredentialProviderParameter createCredentialProviderParameter()
Create a newCredentialProviderParameterlinked to this object.- Returns:
- a new
CredentialProviderParameter.
-
getCredentialProviderParameterByName
CredentialProviderParameter getCredentialProviderParameterByName(String name)
Get the CredentialProviderParameter by CredentialProvider.- Parameters:
name-- Returns:
- the CredentialProviderParameter, or
nullif it could not be found
-
-