Package org.nuxeo.ecm.automation.server

Class AutomationServerComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.automation.server.AutomationServerComponent

All Implemented Interfaces:

AutomationServer, Adaptable, Component, Extensible, TimestampedService

public class AutomationServerComponent
extends DefaultComponent
implements AutomationServer

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Class<? extends javax.ws.rs.ext.MessageBodyReader<?>>>	readers
protected List<Class<? extends javax.ws.rs.ext.MessageBodyWriter<?>>>	writers
static final String	XP_BINDINGS
static final String	XP_MARSHALLER

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
AutomationServerComponent()

Method Summary

Modifier and Type	Method	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.
<T> T	getAdapter(Class<T> adapter)	Returns an object which is an instance of the given class associated with this object.
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.
void	start(ComponentContext context)	Start the component.
void	stop(ComponentContext context)	Stop the component.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

XP_BINDINGS

public static final String XP_BINDINGS

Since:

10.3

See Also:

• Constant Field Values

XP_MARSHALLER

public static final String XP_MARSHALLER

Since:

10.3

See Also:

• Constant Field Values

writers

protected List<Class<? extends javax.ws.rs.ext.MessageBodyWriter<?>>> writers

readers

protected List<Class<? extends javax.ws.rs.ext.MessageBodyReader<?>>> readers

Constructor Details

AutomationServerComponent

public AutomationServerComponent()

Method Details

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

stop

public void stop(ComponentContext context)
          throws InterruptedException

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

Throws:

InterruptedException

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class DefaultComponent

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

getOperationBinding

public RestBinding getOperationBinding(String name)

Description copied from interface: AutomationServer

Gets a binding given an operation.

Specified by:

getOperationBinding in interface AutomationServer

Parameters:

name - the operation name.

getChainBinding

public RestBinding getChainBinding(String name)

Description copied from interface: AutomationServer

Gets a binding given a chain name.

Specified by:

getChainBinding in interface AutomationServer

Parameters:

name - the chain name

getBindings

public RestBinding[] getBindings()

Description copied from interface: AutomationServer

Gets an array of registered bindings.

Specified by:

getBindings in interface AutomationServer

addBinding

public void addBinding(RestBinding binding)

Description copied from interface: AutomationServer

Registers a new operation binding.

Specified by:

addBinding in interface AutomationServer

Parameters:

binding - the new binding to register

removeBinding

public RestBinding removeBinding(RestBinding binding)

Description copied from interface: AutomationServer

Removes a binding for the given operation name.

Specified by:

removeBinding in interface AutomationServer

Parameters:

binding - the binding to remove

Returns:

the removed binding if any, otherwise null

accept

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

Description copied from interface: AutomationServer

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

Specified by:

accept in interface AutomationServer

getWriters

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

Description copied from interface: AutomationServer

Returns all the registered writers

Specified by:

getWriters in interface AutomationServer

getReaders

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

Specified by:

getReaders in interface AutomationServer

Returns:

all the registered readers