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

Class GetAllNamedOperationsHandler

java.lang.Object

uk.gov.gchq.gaffer.store.operation.handler.named.GetAllNamedOperationsHandler

All Implemented Interfaces:

OperationHandler<GetAllNamedOperations>, OutputOperationHandler<GetAllNamedOperations,Iterable<NamedOperationDetail>>

public class GetAllNamedOperationsHandler
extends Object
implements OutputOperationHandler<GetAllNamedOperations,Iterable<NamedOperationDetail>>

Operation Handler for GetAllNamedOperations

Constructor Summary

Constructors

Constructor	Description
GetAllNamedOperationsHandler(String suffixNamedOperationCacheName)
GetAllNamedOperationsHandler(NamedOperationCache cache)

Method Summary

Modifier and Type	Method	Description
Iterable<NamedOperationDetail>	doOperation(GetAllNamedOperations operation, Context context, Store store)	Retrieves all the Named Operations that a user is allowed to see.
String	getSuffixCacheName()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetAllNamedOperationsHandler

public GetAllNamedOperationsHandler(String suffixNamedOperationCacheName)

GetAllNamedOperationsHandler

public GetAllNamedOperationsHandler(NamedOperationCache cache)

Method Detail

getSuffixCacheName

public String getSuffixCacheName()

doOperation

public Iterable<NamedOperationDetail> doOperation(GetAllNamedOperations operation,
                                                  Context context,
                                                  Store store)
                                           throws OperationException

Retrieves all the Named Operations that a user is allowed to see. As the expected behaviour is to bring back a summary of each operation, the simple flag is set to true. This means all the details regarding access roles and operation chain details are not included in the output.

Specified by:

doOperation in interface OperationHandler<GetAllNamedOperations>

Specified by:

doOperation in interface OutputOperationHandler<GetAllNamedOperations,Iterable<NamedOperationDetail>>

Parameters:

operation - the Operation to be executed

context - the operation chain context, containing the user who executed the operation

store - the Store the operation should be run on

Returns:

an iterable of NamedOperations

Throws:

OperationException - thrown if the cache has not been initialized in the operation declarations file