org.restsql.core

Class Factory

java.lang.Object

org.restsql.core.AbstractFactory

org.restsql.core.Factory

public class Factory
extends AbstractFactory

Creates implementations and also is a facade for other framework factories. Customize the framework with new factories that use custom API implementation classes. Use restsql properties to specify the implementation class names. Note: Factories are always singletons and always produce new objects on request.

Author:

Mark Sawers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Factory.ConnectionFactory Creates JDBC connection objects.
static interface	Factory.RequestDeserializerFactory Creates RequestDeserializer objects.
static interface	Factory.RequestFactory Creates Request objects.
static interface	Factory.ResponseSerializerFactory Creates ResponseSerializer objects.
static interface	Factory.SqlResourceFactory Creates SQLResource objects.
static class	Factory.SqlResourceFactoryException Indicates an error in creating a SQL Resource object from a definition.

Nested classes/interfaces inherited from class org.restsql.core.AbstractFactory

AbstractFactory.FactoryHelper

Constructor Summary

Constructors

Constructor and Description
Factory()

Method Summary

Methods

Modifier and Type	Method and Description
static Request	getChildRequest(Request parentRequest) Creates request for child row with blank params.
static ColumnMetaData	getColumnMetaData() Creates new column meta data object.
static Connection	getConnection(String defaultDatabase) Returns connection.
static Factory.ConnectionFactory	getConnectionFactory() Return connection factory.
static HttpRequestAttributes	getHttpRequestAttributes(String client, String method, String uri, String requestBody, String requestContentType, String responseContentType) Creates HTTP request attributes.
static Request	getRequest(HttpRequestAttributes httpAttributes) Builds request from URI.
static Request	getRequest(HttpRequestAttributes httpAttributes, Request.Type type, String sqlResource, List<RequestValue> resIds, List<RequestValue> params, List<List<RequestValue>> childrenParams, RequestLogger requestLogger) Returns request object with pre-parsed data from the URI.
static Request	getRequest(Request.Type type, String sqlResource, List<RequestValue> resIds, List<RequestValue> params, List<List<RequestValue>> childrenParams, RequestLogger requestLogger) Returns request object with pre-parsed data from the URI.
static RequestDeserializer	getRequestDeserializer(String mediaType) Returns request deserializer.
static RequestLogger	getRequestLogger() Returns request logger.
static ResponseSerializer	getResponseSerializer(String mediaType) Returns response serializer for media type.
static SequenceManager	getSequenceManager() Returns singleton SequenceManager.
static SqlBuilder	getSqlBuilder() Returns existing singleton SqlBuilder.
static SqlResource	getSqlResource(String resName) Returns SQL Resource for named resource.
static InputStream	getSqlResourceDefinition(String resName) Returns definition content as input stream.
static SqlResourceMetaData	getSqlResourceMetaData(String resName, SqlResourceDefinition definition, SqlBuilder sqlBuilder) Returns meta data object for definition.
static List<String>	getSqlResourceNames() Returns available SQL Resource names using configured SqlResourceFactory.
static String	getSqlResourcesDir() Returns SQL resources directory using configured SqlResourceFactory.
static TableMetaData	getTableMetaData() Creates new table meta data object.
static void	reloadSqlResource(String resName) Reloads definition from the source using configured SqlResourceFactory.

Methods inherited from class org.restsql.core.AbstractFactory

getInstance, newInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

Factory

public Factory()

Method Detail

getChildRequest

public static Request getChildRequest(Request parentRequest)

Creates request for child row with blank params. Configurable implementation class.

getColumnMetaData

public static ColumnMetaData getColumnMetaData()

Creates new column meta data object. Configurable implementation class.

getConnection

public static Connection getConnection(String defaultDatabase)
                                throws SQLException

Returns connection.

Throws:

SQLException

getConnectionFactory

public static Factory.ConnectionFactory getConnectionFactory()

Return connection factory. Useful for destroying it on app unload. Configurable implementation class.

getHttpRequestAttributes

public static HttpRequestAttributes getHttpRequestAttributes(String client,
                                             String method,
                                             String uri,
                                             String requestBody,
                                             String requestContentType,
                                             String responseContentType)

Creates HTTP request attributes. Configurable implementation class.

Parameters:

client - IP or host name

method - HTTP method

uri - request URI

requestBody - request body, e.g. XML or JSON

getRequest

public static Request getRequest(Request.Type type,
                 String sqlResource,
                 List<RequestValue> resIds,
                 List<RequestValue> params,
                 List<List<RequestValue>> childrenParams,
                 RequestLogger requestLogger)
                          throws InvalidRequestException

Returns request object with pre-parsed data from the URI. Used by Java API clients.

Throws:

InvalidRequestException

getRequest

public static Request getRequest(HttpRequestAttributes httpAttributes,
                 Request.Type type,
                 String sqlResource,
                 List<RequestValue> resIds,
                 List<RequestValue> params,
                 List<List<RequestValue>> childrenParams,
                 RequestLogger requestLogger)
                          throws InvalidRequestException

Returns request object with pre-parsed data from the URI. Used by service and Java API clients. Configurable implementation class.

Throws:

InvalidRequestException

getRequest

public static Request getRequest(HttpRequestAttributes httpAttributes)
                          throws InvalidRequestException,
                                 Factory.SqlResourceFactoryException,
                                 SqlResourceException

Builds request from URI. Assumes pattern res/{resourceName}/{resId1}/{resId2}?{param1}={value1}&{param2}={value2}. Used by the test harness, Java API clients and perhaps a straight servlet implementation. Configurable implementation class.

Throws:

InvalidRequestException

Factory.SqlResourceFactoryException

SqlResourceException

getRequestLogger

public static RequestLogger getRequestLogger()

Returns request logger. Configurable implementation class.

getRequestDeserializer

public static RequestDeserializer getRequestDeserializer(String mediaType)
                                                  throws SqlResourceException

Returns request deserializer. Configurable implementation class.

Throws:

SqlResourceException - if deserializer not found for media type

getResponseSerializer

public static ResponseSerializer getResponseSerializer(String mediaType)
                                                throws SqlResourceException

Returns response serializer for media type. Configurable implementation class.

Throws:

SqlResourceException - if serializer not found for media type

getSequenceManager

public static SequenceManager getSequenceManager()

Returns singleton SequenceManager. Configurable implementation class.

getSqlBuilder

public static SqlBuilder getSqlBuilder()

Returns existing singleton SqlBuilder. Configurable implementation.

getSqlResource

public static SqlResource getSqlResource(String resName)
                                  throws Factory.SqlResourceFactoryException,
                                         SqlResourceException

Returns SQL Resource for named resource. Configurable implementation class.

Parameters:

resName - resource name

Returns:

SQLResource object

Throws:

Factory.SqlResourceFactoryException - if the definition could not be marshalled

SqlResourceException - if a database error occurs while collecting metadata

getSqlResourceDefinition

public static InputStream getSqlResourceDefinition(String resName)
                                            throws Factory.SqlResourceFactoryException

Returns definition content as input stream. Configurable implementation class.

Throws:

Factory.SqlResourceFactoryException

getSqlResourceMetaData

public static SqlResourceMetaData getSqlResourceMetaData(String resName,
                                         SqlResourceDefinition definition,
                                         SqlBuilder sqlBuilder)
                                                  throws SqlResourceException

Returns meta data object for definition. Configurable implementation class.

Parameters:

sqlBuilder - db-specific SQL builder

Throws:

SqlResourceException - if a database access error occurs

getSqlResourcesDir

public static String getSqlResourcesDir()

Returns SQL resources directory using configured SqlResourceFactory.

getSqlResourceNames

public static List<String> getSqlResourceNames()
                                        throws Factory.SqlResourceFactoryException

Returns available SQL Resource names using configured SqlResourceFactory.

Throws:

Factory.SqlResourceFactoryException - if the configured directory does not exist

getTableMetaData

public static TableMetaData getTableMetaData()

Creates new table meta data object. Configurable implementation class.

reloadSqlResource

public static void reloadSqlResource(String resName)
                              throws Factory.SqlResourceFactoryException,
                                     SqlResourceException

Reloads definition from the source using configured SqlResourceFactory. This operation is not thread safe and should be run in development mode only.

Parameters:

resName - resource name

Throws:

Factory.SqlResourceFactoryException - if the definition could not be marshalled

SqlResourceException - if a database error occurs while collecting metadata