Package com.redwood.scheduler.api.model

Interface CredentialProtocol

All Superinterfaces:

ApplicationObject, BusinessKeyObject, CredentialProtocolComp, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Readable, Root, SchedulerEntity, SchedulerEntityComp, UniqueNamedApplicationObject

public interface CredentialProtocol
extends CredentialProtocolComp, UniqueNamedApplicationObject, Readable

A protocol used to access an external system. Used in conjunction with a Credential.

Field Summary

Fields

Modifier and Type	Field	Description
static String	HTTP	The name of the HTTP credential protocol.
static String	JDBC	The name of the credential protocol used to connect to the database for JDBC and Oracle jobs.
static String	LOGIN	The name of the login Credential protocol.
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "CredentialProtocol" objects.
static String	Oracle	The name of the credential protocol used to connect to the database for SQLPLUS jobs.
static String	Passphrase	The name of the credential protocol used to store (SSH) passphrases.
static String	PEOPLESOFT	The name of the PeopleSoft Credential protocol.
static String	Putty	The name of the credential protocol to store Putty private keys
static String	SAP_RFC	The name of the SAP R/3 Credential protocol.
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 String	SOAP	The name of the SOAP credential protocol.
static String	SSH	The name of the credential protocol to store SSH private keys
static QueryObjectType<CredentialProtocol>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
static String	X509_ClientCertificate	The name of the X509_ClientCertificate credential protocol.
static String	X509_TrustedCertificate	The name of the X509_TrustedCertificate credential protocol.

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.
Credential	getCredentialByPartitionEndpointRealUser(Partition partition, String endpoint, String realUser)	Get the Credential by CredentialProtocolEndpointRealUser.
Credential	getCredentialByPartitionEndpointVirtualUser(Partition partition, String endpoint, String virtualUser)	Get the Credential by CredentialProtocolEndpointVirtualUser.
RWIterable<Credential>	getCredentials()	Get an RWIterable over an ordered collection of Credentials.
CredentialProtocolType	getType()	Get the value for Type.
void	setType(CredentialProtocolType newType)	Set the value for Type.

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 "CredentialProtocol" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<CredentialProtocol> TYPE

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

LOGIN

static final String LOGIN

The name of the login Credential protocol.

See Also:

Constant Field Values

SAP_RFC

static final String SAP_RFC

The name of the SAP R/3 Credential protocol.

See Also:

Constant Field Values

PEOPLESOFT

static final String PEOPLESOFT

The name of the PeopleSoft Credential protocol.

See Also:

Constant Field Values

Oracle

static final String Oracle

The name of the credential protocol used to connect to the database for SQLPLUS jobs.

See Also:

Constant Field Values

JDBC

static final String JDBC

The name of the credential protocol used to connect to the database for JDBC and Oracle jobs.

See Also:

Constant Field Values

SOAP

static final String SOAP

The name of the SOAP credential protocol.

See Also:

Constant Field Values

Passphrase

static final String Passphrase

The name of the credential protocol used to store (SSH) passphrases.

See Also:

Constant Field Values

Putty

static final String Putty

The name of the credential protocol to store Putty private keys

See Also:

Constant Field Values

SSH

static final String SSH

The name of the credential protocol to store SSH private keys

See Also:

Constant Field Values

HTTP

static final String HTTP

The name of the HTTP credential protocol.

See Also:

Constant Field Values

X509_TrustedCertificate

static final String X509_TrustedCertificate

The name of the X509_TrustedCertificate credential protocol.

See Also:

Constant Field Values

X509_ClientCertificate

static final String X509_ClientCertificate

The name of the X509_ClientCertificate credential protocol.

See Also:

Constant Field Values

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

getType

CredentialProtocolType getType()

Get the value for Type. (Defines the type of the protocol)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setType

void setType(CredentialProtocolType newType)

Set the value for Type. (Defines the type of the protocol) This value is optional.

Parameters:

newType - the new value for Type.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getCredentials

RWIterable<Credential> getCredentials()

Get an RWIterable over an ordered collection of Credentials. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. What protocol is used for the credential?

Specified by:

getCredentials in interface CredentialProtocolComp

Returns:

An RWIterable over an ordered collection of Credential objects .

getCredentialByPartitionEndpointRealUser

Credential getCredentialByPartitionEndpointRealUser(Partition partition,
                                                    String endpoint,
                                                    String realUser)

Get the Credential by CredentialProtocolEndpointRealUser.

Parameters:

partition -

endpoint -

realUser -

Returns:

the Credential, or null if it could not be found

getCredentialByPartitionEndpointVirtualUser

Credential getCredentialByPartitionEndpointVirtualUser(Partition partition,
                                                       String endpoint,
                                                       String virtualUser)

Get the Credential by CredentialProtocolEndpointVirtualUser.

Parameters:

partition -

endpoint -

virtualUser -

Returns:

the Credential, 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.