org.everrest.groovy

Class GroovyResourcePublisher

java.lang.Object

org.everrest.groovy.GroovyResourcePublisher

public class GroovyResourcePublisher
extends Object

Manage via ResourceBinder Groovy based RESTful services.

Author:

andrew00x

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceBinder	binder
protected GroovyClassLoaderProvider	classLoaderProvider
protected Comparator<Constructor<?>>	CONSTRUCTOR_COMPARATOR
protected static Charset	DEFAULT_CHARSET Default character set.
protected static String	DEFAULT_CHARSET_NAME Default character set name.
protected DependencySupplier	dependencies
protected Map<ResourceId,String>	resources

Constructor Summary

Constructors

Modifier	Constructor and Description
	GroovyResourcePublisher(ResourceBinder binder, DependencySupplier dependencies) Create GroovyJaxrsPublisher which is able publish per-request and singleton resources.
protected	GroovyResourcePublisher(ResourceBinder binder, GroovyClassLoaderProvider classLoaderProvider, DependencySupplier dependencies) Create GroovyJaxrsPublisher which is able publish per-request and singleton resources.

Method Summary

Modifier and Type	Method and Description
protected groovy.lang.GroovyCodeSource	createCodeSource(InputStream in, String name) Create GroovyCodeSource from given stream and name.
protected Object	createInstance(Class<?> clazz)
ObjectFactory<AbstractResourceDescriptor>	getResource(ResourceId resourceId) Get resource corresponded to specified id resourceId .
boolean	isPublished(ResourceId resourceId) Check is groovy resource with specified id is published or not
void	publishPerRequest(InputStream in, ResourceId resourceId, javax.ws.rs.core.MultivaluedMap<String,String> properties, SourceFolder[] src, SourceFile[] files) Parse given stream and publish result as per-request RESTful service.
void	publishPerRequest(String source, ResourceId resourceId, javax.ws.rs.core.MultivaluedMap<String,String> properties, SourceFolder[] src, SourceFile[] files) Parse given source and publish result as per-request RESTful service.
void	publishPerRequest(String source, String charset, ResourceId resourceId, javax.ws.rs.core.MultivaluedMap<String,String> properties, SourceFolder[] src, SourceFile[] files) Parse given source and publish result as per-request RESTful service.
void	publishSingleton(InputStream in, ResourceId resourceId, javax.ws.rs.core.MultivaluedMap<String,String> properties, SourceFolder[] src, SourceFile[] files) Parse given stream and publish result as singleton RESTful service.
void	publishSingleton(String source, ResourceId resourceId, javax.ws.rs.core.MultivaluedMap<String,String> properties, SourceFolder[] src, SourceFile[] files) Parse given source and publish result as singleton RESTful service.
void	publishSingleton(String source, String charset, ResourceId resourceId, javax.ws.rs.core.MultivaluedMap<String,String> properties, SourceFolder[] src, SourceFile[] files) Parse given source and publish result as singleton RESTful service.
ObjectFactory<AbstractResourceDescriptor>	unpublishResource(ResourceId resourceId) Unpublish resource with specified id.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET_NAME

protected static final String DEFAULT_CHARSET_NAME

Default character set name.

See Also:

Constant Field Values

DEFAULT_CHARSET

protected static final Charset DEFAULT_CHARSET

Default character set.

binder

protected final ResourceBinder binder

resources

protected final Map<ResourceId,String> resources

classLoaderProvider

protected final GroovyClassLoaderProvider classLoaderProvider

dependencies

protected final DependencySupplier dependencies

CONSTRUCTOR_COMPARATOR

protected final Comparator<Constructor<?>> CONSTRUCTOR_COMPARATOR

Constructor Detail

GroovyResourcePublisher

protected GroovyResourcePublisher(ResourceBinder binder,
                                  GroovyClassLoaderProvider classLoaderProvider,
                                  DependencySupplier dependencies)

Create GroovyJaxrsPublisher which is able publish per-request and singleton resources. Any required dependencies for per-request resource injected by PerRequestObjectFactory.

Parameters:

binder - resource binder

classLoaderProvider - GroovyClassLoaderProvider

dependencies - dependencies resolver

See Also:

DependencySupplier

GroovyResourcePublisher

public GroovyResourcePublisher(ResourceBinder binder,
                               DependencySupplier dependencies)

Create GroovyJaxrsPublisher which is able publish per-request and singleton resources. Any required dependencies for per-request resource injected by PerRequestObjectFactory.

Parameters:

binder - resource binder

dependencies - dependencies resolver

See Also:

DependencySupplier

Method Detail

getResource

public ObjectFactory<AbstractResourceDescriptor> getResource(ResourceId resourceId)

Get resource corresponded to specified id resourceId .

Parameters:

resourceId - resource id

Returns:

resource or null

isPublished

public boolean isPublished(ResourceId resourceId)

Check is groovy resource with specified id is published or not

Parameters:

resourceId - id of resource to be checked

Returns:

true if resource is published and false* otherwise

publishPerRequest

public void publishPerRequest(InputStream in,
                              ResourceId resourceId,
                              javax.ws.rs.core.MultivaluedMap<String,String> properties,
                              SourceFolder[] src,
                              SourceFile[] files)

Parse given stream and publish result as per-request RESTful service.

Parameters:

in - stream which contains groovy source code of RESTful service

resourceId - id to be assigned to resource

properties - optional resource properties. This parameter may be null

src - additional path to Groovy sources

files - Groovy source files to be added in build path directly

Throws:

ResourcePublicationException - see ResourceBinder.addResource(Class, MultivaluedMap)

publishPerRequest

public final void publishPerRequest(String source,
                                    ResourceId resourceId,
                                    javax.ws.rs.core.MultivaluedMap<String,String> properties,
                                    SourceFolder[] src,
                                    SourceFile[] files)

Parse given source and publish result as per-request RESTful service.

Parameters:

source - groovy source code of RESTful service

resourceId - id to be assigned to resource

properties - optional resource properties. This parameter may be null

src - additional path to Groovy sources

files - Groovy source files to be added in build path directly

Throws:

ResourcePublicationException - see ResourceBinder.addResource(Class, MultivaluedMap)

publishPerRequest

public final void publishPerRequest(String source,
                                    String charset,
                                    ResourceId resourceId,
                                    javax.ws.rs.core.MultivaluedMap<String,String> properties,
                                    SourceFolder[] src,
                                    SourceFile[] files)

Parse given source and publish result as per-request RESTful service.

Parameters:

source - groovy source code of RESTful service

charset - source string charset. May be null than default charset will be in use

resourceId - id to be assigned to resource

properties - optional resource properties. This parameter may be null.

src - additional path to Groovy sources

files - Groovy source files to be added in build path directly

Throws:

UnsupportedCharsetException - if charset is unsupported

ResourcePublicationException - see ResourceBinder.addResource(Class, MultivaluedMap)

publishSingleton

public void publishSingleton(InputStream in,
                             ResourceId resourceId,
                             javax.ws.rs.core.MultivaluedMap<String,String> properties,
                             SourceFolder[] src,
                             SourceFile[] files)

Parse given stream and publish result as singleton RESTful service.

Parameters:

in - stream which contains groovy source code of RESTful service

resourceId - id to be assigned to resource

properties - optional resource properties. This parameter may be null

src - additional path to Groovy sources

files - Groovy source files to be added in build path directly

Throws:

ResourcePublicationException - see ResourceBinder.addResource(Object, MultivaluedMap)

publishSingleton

public final void publishSingleton(String source,
                                   ResourceId resourceId,
                                   javax.ws.rs.core.MultivaluedMap<String,String> properties,
                                   SourceFolder[] src,
                                   SourceFile[] files)

Parse given source and publish result as singleton RESTful service.

Parameters:

source - groovy source code of RESTful service

resourceId - name of resource

properties - optional resource properties. This parameter may be null.

src - additional path to Groovy sources

files - Groovy source files to be added in build path directly

Throws:

ResourcePublicationException - see ResourceBinder.addResource(Object, MultivaluedMap)

publishSingleton

public final void publishSingleton(String source,
                                   String charset,
                                   ResourceId resourceId,
                                   javax.ws.rs.core.MultivaluedMap<String,String> properties,
                                   SourceFolder[] src,
                                   SourceFile[] files)

Parse given source and publish result as singleton RESTful service.

Parameters:

source - groovy source code of RESTful service

charset - source string charset. May be null than default charset will be in use

resourceId - name of resource

properties - optional resource properties. This parameter may be null.

src - additional path to Groovy sources

files - Groovy source files to be added in build path directly

Throws:

UnsupportedCharsetException - if charset is unsupported

ResourcePublicationException - see ResourceBinder.addResource(Object, MultivaluedMap)

unpublishResource

public ObjectFactory<AbstractResourceDescriptor> unpublishResource(ResourceId resourceId)

Unpublish resource with specified id.

Parameters:

resourceId - id of resource to be unpublished

Returns:

true if resource was published and false otherwise, e.g. because there is not resource corresponded to supplied resourceId

createInstance

protected Object createInstance(Class<?> clazz)
                         throws IllegalArgumentException,
                                InstantiationException,
                                IllegalAccessException,
                                InvocationTargetException

Throws:

IllegalArgumentException

InstantiationException

IllegalAccessException

InvocationTargetException

createCodeSource

protected groovy.lang.GroovyCodeSource createCodeSource(InputStream in,
                                                        String name)

Create GroovyCodeSource from given stream and name. Code base 'file:/groovy/script/jaxrs' will be used.

Parameters:

in - groovy source code stream

name - code source name

Returns:

GroovyCodeSource