org.nuxeo.ecm.automation.server

Interface AutomationServer

All Known Implementing Classes:

AutomationServerComponent

public interface AutomationServer

A registry of REST bindings. Provides methods for checking if a given operation is allowed to be invoked in a REST call.

The binding registry is synchronized.

Author:

Bogdan Stefanescu

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(String name, boolean isChain, javax.servlet.http.HttpServletRequest req) Checks if the given operation name is allowed in a REST call.
void	addBinding(RestBinding binding) Registers a new operation binding.
RestBinding[]	getBindings() Gets an array of registered bindings.
RestBinding	getChainBinding(String name) Gets a binding given a chain name.
RestBinding	getOperationBinding(String name) Gets a binding given an operation.
List<Class<? extends javax.ws.rs.ext.MessageBodyReader<?>>>	getReaders()
List<Class<? extends javax.ws.rs.ext.MessageBodyWriter<?>>>	getWriters() Returns all the registered writers
RestBinding	removeBinding(RestBinding binding) Removes a binding for the given operation name.

Method Detail

getOperationBinding

RestBinding getOperationBinding(String name)

Gets a binding given an operation.

Parameters:

name - the operation name.

getChainBinding

RestBinding getChainBinding(String name)

Gets a binding given a chain name.

Parameters:

name - the chain name

getBindings

RestBinding[] getBindings()

Gets an array of registered bindings.

addBinding

void addBinding(RestBinding binding)

Registers a new operation binding.

Parameters:

binding - the new binding to register

removeBinding

RestBinding removeBinding(RestBinding binding)

Removes a binding for the given operation name.

Parameters:

binding - the binding to remove

Returns:

the removed binding if any, otherwise null

accept

boolean accept(String name,
             boolean isChain,
             javax.servlet.http.HttpServletRequest req)

Checks if the given operation name is allowed in a REST call.

getWriters

List<Class<? extends javax.ws.rs.ext.MessageBodyWriter<?>>> getWriters()

Returns all the registered writers

Returns:

Since:

5.8

getReaders

List<Class<? extends javax.ws.rs.ext.MessageBodyReader<?>>> getReaders()

Returns:

all the registered readers

Since:

5.8