Package uk.gov.gchq.gaffer.named.operation

Class NamedOperationDetail

java.lang.Object

uk.gov.gchq.gaffer.named.operation.NamedOperationDetail

All Implemented Interfaces:

Serializable, AccessControlledResource

public class NamedOperationDetail
extends Object
implements AccessControlledResource, Serializable

Simple POJO containing the details associated with a NamedOperation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NamedOperationDetail.Builder

Field Summary

Fields inherited from interface uk.gov.gchq.gaffer.access.AccessControlledResource

DONT_CHECK_ADMIN_AUTH

Constructor Summary

Constructors

Constructor	Description
NamedOperationDetail(String operationName, String inputType, String description, String userId, String operations, List<String> readers, List<String> writers, Map<String,ParameterDetail> parameters, Integer score)
NamedOperationDetail(String operationName, String description, String userId, String operations, List<String> readers, List<String> writers, Map<String,ParameterDetail> parameters, Integer score)
NamedOperationDetail(String operationName, List<String> labels, String inputType, String description, String userId, String operations, List<String> readers, List<String> writers, Map<String,ParameterDetail> parameters, Integer score)
NamedOperationDetail(String operationName, List<String> labels, String inputType, String description, String userId, String operations, List<String> readers, List<String> writers, Map<String,ParameterDetail> parameters, Integer score, AccessPredicate readAccessPredicate, AccessPredicate writeAccessPredicate)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getCreatorId()
String	getDescription()
String	getInputType()
List<String>	getLabels()
OperationChain	getOperationChain(Map<String,Object> executionParams)	Gets the OperationChain after adding in any provided parameters.
OperationChain	getOperationChainWithDefaultParams()	Gets the OperationChain after adding in default values for any parameters.
String	getOperationName()
String	getOperations()
AccessPredicate	getOrDefaultReadAccessPredicate()
AccessPredicate	getOrDefaultWriteAccessPredicate()
Map<String,ParameterDetail>	getParameters()
AccessPredicate	getReadAccessPredicate()
List<String>	getReadAccessRoles()
ResourceType	getResourceType()
Integer	getScore()
AccessPredicate	getWriteAccessPredicate()
List<String>	getWriteAccessRoles()
int	hashCode()
boolean	hasReadAccess(User user, String adminAuth)
boolean	hasWriteAccess(User user, String adminAuth)
void	setInputType(String inputType)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.gov.gchq.gaffer.access.AccessControlledResource

hasReadAccess, hasWriteAccess

Constructor Detail

NamedOperationDetail

public NamedOperationDetail(String operationName,
                            String description,
                            String userId,
                            String operations,
                            List<String> readers,
                            List<String> writers,
                            Map<String,ParameterDetail> parameters,
                            Integer score)

NamedOperationDetail

public NamedOperationDetail(String operationName,
                            String inputType,
                            String description,
                            String userId,
                            String operations,
                            List<String> readers,
                            List<String> writers,
                            Map<String,ParameterDetail> parameters,
                            Integer score)

NamedOperationDetail

public NamedOperationDetail(String operationName,
                            List<String> labels,
                            String inputType,
                            String description,
                            String userId,
                            String operations,
                            List<String> readers,
                            List<String> writers,
                            Map<String,ParameterDetail> parameters,
                            Integer score)

NamedOperationDetail

public NamedOperationDetail(String operationName,
                            List<String> labels,
                            String inputType,
                            String description,
                            String userId,
                            String operations,
                            List<String> readers,
                            List<String> writers,
                            Map<String,ParameterDetail> parameters,
                            Integer score,
                            AccessPredicate readAccessPredicate,
                            AccessPredicate writeAccessPredicate)

Method Detail

getOperationName

public String getOperationName()

getLabels

public List<String> getLabels()

getInputType

public String getInputType()

setInputType

public void setInputType(String inputType)

getDescription

public String getDescription()

getOperations

public String getOperations()

getReadAccessRoles

public List<String> getReadAccessRoles()

getWriteAccessRoles

public List<String> getWriteAccessRoles()

getCreatorId

public String getCreatorId()

getParameters

public Map<String,ParameterDetail> getParameters()

getScore

public Integer getScore()

getOperationChainWithDefaultParams

public OperationChain getOperationChainWithDefaultParams()

Gets the OperationChain after adding in default values for any parameters. If a parameter does not have a default, null is inserted.

Returns:

The OperationChain

Throws:

IllegalArgumentException - if substituting the parameters fails

getOperationChain

public OperationChain getOperationChain(Map<String,Object> executionParams)

Gets the OperationChain after adding in any provided parameters.

Parameters:

executionParams - the parameters for the Operation to be executed

Returns:

The OperationChain

Throws:

IllegalArgumentException - if substituting the parameters fails

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in interface AccessControlledResource

hasReadAccess

public boolean hasReadAccess(User user,
                             String adminAuth)

Specified by:

hasReadAccess in interface AccessControlledResource

hasWriteAccess

public boolean hasWriteAccess(User user,
                              String adminAuth)

Specified by:

hasWriteAccess in interface AccessControlledResource

getReadAccessPredicate

public AccessPredicate getReadAccessPredicate()

getWriteAccessPredicate

public AccessPredicate getWriteAccessPredicate()

getOrDefaultReadAccessPredicate

public AccessPredicate getOrDefaultReadAccessPredicate()

getOrDefaultWriteAccessPredicate

public AccessPredicate getOrDefaultWriteAccessPredicate()