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 and Description
protected Map<String,RestBinding>	bindings
protected IOComponent	ioComponent
protected static String	IOCOMPONENT_NAME
protected Map<String,RestBinding>	lookup
protected List<Class<? extends javax.ws.rs.ext.MessageBodyReader<?>>>	readers
protected List<Class<? extends javax.ws.rs.ext.MessageBodyWriter<?>>>	writers
protected static String	XP_BINDINGS
protected static String	XP_CODECS

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

lastModified

Constructor Summary

Constructors

Constructor and Description
AutomationServerComponent()

Method Summary

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	activate(ComponentContext context) Activates the component.
void	addBinding(RestBinding binding) Registers a new operation binding.
void	deactivate(ComponentContext context) Deactivates the component.
<T> T	getAdapter(Class<T> adapter) Returns an object which is an instance of the given class associated with this object.
protected String	getBindingKey(RestBinding 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
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
RestBinding	removeBinding(RestBinding binding) Removes a binding for the given operation name.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

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

getLastModified, registerExtension, setLastModified, setModifiedNow, start, stop, 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

applicationStarted, getApplicationStartedOrder

Field Detail

XP_BINDINGS

protected static final String XP_BINDINGS

See Also:

Constant Field Values

IOCOMPONENT_NAME

protected static final String IOCOMPONENT_NAME

See Also:

Constant Field Values

ioComponent

protected IOComponent ioComponent

bindings

protected Map<String,RestBinding> bindings

XP_CODECS

protected static final String XP_CODECS

See Also:

Constant Field Values

lookup

protected volatile Map<String,RestBinding> lookup

writers

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

readers

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

Constructor Detail

AutomationServerComponent

public AutomationServerComponent()

Method Detail

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

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

getBindingKey

protected String getBindingKey(RestBinding binding)

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

Returns:

getReaders

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

Specified by:

getReaders in interface AutomationServer

Returns:

all the registered readers