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 String
XP_BINDINGS
static String
XP_MARSHALLER
-
Fields inherited from class org.nuxeo.runtime.model.DefaultComponent
lastModified, name
-
-
Constructor Summary
Constructors Constructor Description AutomationServerComponent()
-
Method Summary
All Methods Instance Methods Concrete Methods 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 writersRestBinding
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
applicationStarted, getApplicationStartedOrder
-
-
-
-
Field Detail
-
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
-
-
Method Detail
-
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 interfaceComponent
- Overrides:
start
in classDefaultComponent
-
stop
public void stop(ComponentContext context) throws InterruptedException
Description copied from interface:Component
Stop the component.- Specified by:
stop
in interfaceComponent
- Overrides:
stop
in classDefaultComponent
- 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. Returnsnull
if no such object can be found.- Specified by:
getAdapter
in interfaceAdaptable
- Overrides:
getAdapter
in classDefaultComponent
- 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 interfaceAutomationServer
- 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 interfaceAutomationServer
- Parameters:
name
- the chain name
-
getBindings
public RestBinding[] getBindings()
Description copied from interface:AutomationServer
Gets an array of registered bindings.- Specified by:
getBindings
in interfaceAutomationServer
-
addBinding
public void addBinding(RestBinding binding)
Description copied from interface:AutomationServer
Registers a new operation binding.- Specified by:
addBinding
in interfaceAutomationServer
- 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 interfaceAutomationServer
- 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 interfaceAutomationServer
-
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 interfaceAutomationServer
-
getReaders
public List<Class<? extends javax.ws.rs.ext.MessageBodyReader<?>>> getReaders()
- Specified by:
getReaders
in interfaceAutomationServer
- Returns:
- all the registered readers
-
-