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
static AutomationServerComponent	me Deprecated.

Constructor Summary

Constructors

Constructor and Description
AutomationServerComponent()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(String name, boolean isChain, 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	applicationStarted(ComponentContext context) Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.
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.
RestBinding[]	getBindings() Gets an array of registered bindings.
RestBinding	getChainBinding(String name) Gets a binding given a chain name.
org.codehaus.jackson.JsonFactory	getFactory() Deprecated.
RestBinding	getOperationBinding(String name) Gets a binding given an operation.
List<Class<? extends MessageBodyReader<?>>>	getReaders()
List<Class<? extends 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

getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

me

@Deprecated
public static AutomationServerComponent me

Deprecated.

Was used to get the JsonFactory, but since 5.7.3 use either: * JsonFactoryManager.getJsonFactory() * Context annotation in JAX-RS object (providers or resources)

Constructor Detail

AutomationServerComponent

public AutomationServerComponent()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

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

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

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

Throws:

Exception - if an error occurs during activation

registerContribution

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

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

unregisterContribution

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

Overrides:

unregisterContribution in class DefaultComponent

Throws:

Exception

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

applicationStarted

public void applicationStarted(ComponentContext context)
                        throws Exception

Description copied from interface: Component

Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.

Specified by:

applicationStarted in interface Component

Overrides:

applicationStarted in class DefaultComponent

Throws:

Exception

getFactory

@Deprecated
public org.codehaus.jackson.JsonFactory getFactory()

Deprecated.

Since 5.7.3, use JsonFactoryManager.getJsonFactory()

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,
             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 MessageBodyWriter<?>>> getWriters()

Description copied from interface: AutomationServer

Returns all the registered writers

Specified by:

getWriters in interface AutomationServer

Returns:

getReaders

public List<Class<? extends MessageBodyReader<?>>> getReaders()

Specified by:

getReaders in interface AutomationServer

Returns:

all the registered readers