public interface AccessPlugin
Modifier and Type | Method and Description |
---|---|
DeleteResponse |
processPostDelete(DeleteResponse input)
Processes a
DeleteResponse , following the execution of CatalogProvider.delete(DeleteRequest) , to determine whether or not the user
can access the Catalog operation |
QueryResponse |
processPostQuery(QueryResponse input)
Processes a
QueryResponse , following the execution of the Query , to determine whether or not the user can access the Response. |
ResourceResponse |
processPostResource(ResourceResponse input,
Metacard metacard)
Processes a
ResourceResponse , following the execution of the ResourceRequest , to determine whether or not the user can access the
Response. |
CreateRequest |
processPreCreate(CreateRequest input)
Processes a
CreateRequest , prior to CatalogProvider.create(CreateRequest) , to determine whether or not the user
can access the Catalog operation |
DeleteRequest |
processPreDelete(DeleteRequest input)
Processes a
DeleteRequest , prior to CatalogProvider.delete(DeleteRequest) , to determine whether or not the user
can access the Catalog operation |
QueryRequest |
processPreQuery(QueryRequest input)
Processes a
QueryRequest , prior to execution of the Query , to determine whether or not the user can access the Catalog
operation. |
ResourceRequest |
processPreResource(ResourceRequest input)
Processes a
ResourceRequest , prior to execution of the ResourceRequest , to determine whether or not the user can access the
Catalog operation. |
UpdateRequest |
processPreUpdate(UpdateRequest input,
Map<String,Metacard> existingMetacards)
Processes an
UpdateRequest , prior to execution of the Update , to determine whether or not the user can access the Catalog
operation |
CreateRequest processPreCreate(CreateRequest input) throws StopProcessingException
CreateRequest
, prior to CatalogProvider.create(CreateRequest)
, to determine whether or not the user
can access the Catalog operationinput
- the CreateRequest
to processCreateRequest
to pass to the next AccessPlugin
StopProcessingException
- thrown to halt processing when a critical issue occurs during
processing. This is intended to prevent other plugins from processing as well.UpdateRequest processPreUpdate(UpdateRequest input, Map<String,Metacard> existingMetacards) throws StopProcessingException
UpdateRequest
, prior to execution of the Update
, to determine whether or not the user can access the Catalog
operationinput
- the UpdateRequest
to processexistingMetacards
- the Map of Metacard
s that currently existUpdateRequest
to pass to the next AccessPlugin
StopProcessingException
- thrown to halt processing when a critical issue occurs during
processing. This is intended to prevent other plugins from processing as well.DeleteRequest processPreDelete(DeleteRequest input) throws StopProcessingException
DeleteRequest
, prior to CatalogProvider.delete(DeleteRequest)
, to determine whether or not the user
can access the Catalog operationinput
- the DeleteRequest
to processDeleteRequest
to pass to the next AccessPlugin
StopProcessingException
- thrown to halt processing when a critical issue occurs during
processing. This is intended to prevent other plugins from processing as well.DeleteResponse processPostDelete(DeleteResponse input) throws StopProcessingException
DeleteResponse
, following the execution of CatalogProvider.delete(DeleteRequest)
, to determine whether or not the user
can access the Catalog operationinput
- the DeleteResponse
to processDeleteResponse
to pass to the next AccessPlugin
StopProcessingException
- thrown to halt processing when a critical issue occurs during
processing. This is intended to prevent other plugins from processing as well.QueryRequest processPreQuery(QueryRequest input) throws StopProcessingException
QueryRequest
, prior to execution of the Query
, to determine whether or not the user can access the Catalog
operation. The AccessPlugins will be run in the same order for both processPreQuery and
processPostQueryinput
- the QueryRequest
to processQueryRequest
to pass to the next AccessPlugin
StopProcessingException
- thrown to halt processing when a critical issue occurs during
processing. This is intended to prevent other plugins from processing as well.QueryResponse processPostQuery(QueryResponse input) throws StopProcessingException
QueryResponse
, following the execution of the Query
, to determine whether or not the user can access the Response. The
AccessPlugins will be run in the same order for both processPreQuery and processPostQueryinput
- the QueryResponse
to processQueryResponse
to pass to the next AccessPlugin
StopProcessingException
- thrown to halt processing when a critical issue occurs during
processing. This is intended to prevent other plugins from processing as well.ResourceRequest processPreResource(ResourceRequest input) throws StopProcessingException
ResourceRequest
, prior to execution of the ResourceRequest
, to determine whether or not the user can access the
Catalog operation. The AccessPlugins will be run in the same order for both processPreQuery and
processPostQueryinput
- the ResourceRequest
to processQueryRequest
to pass to the next AccessPlugin
StopProcessingException
- thrown to halt processing when a critical issue occurs during
processing. This is intended to prevent other plugins from processing as well.ResourceResponse processPostResource(ResourceResponse input, Metacard metacard) throws StopProcessingException
ResourceResponse
, following the execution of the ResourceRequest
, to determine whether or not the user can access the
Response. The AccessPlugins will be run in the same order for both processPreResource and
processPostResourceinput
- the ResourceResponse
to processResourceResponse
to pass to the next AccessPlugin
StopProcessingException
- thrown to halt processing when a critical issue occurs during
processing. This is intended to prevent other plugins from processing as well.This work is licensed under a Creative Commons Attribution 4.0 International License.