com.viaoa.remote.rest

Class OARestClient

java.lang.Object

com.viaoa.remote.rest.OARestClient

public class OARestClient
extends Object

OARestClient is a client for directly accessing HTTP endpoints, and for creating Java interfaces that OARestClient.getInstance will then create an implementation that will use HTTP to make distributed calls to webserver endpoints, REST API calls, OAGraph objects, or Java2Java method calls when a method is invoked on the client.

To create remote method calls, a Java Interface is used with annotations to describe the behavior and interaction with the remote server. OARestClient getInstance(class) can then be used to get an implementation that will automatically have the method invoke use HTTP to get the method's return value.

Methods can be defined to automatically call:
1: web url
2: REST API call
3: OA Graph - query, persistence, method calls by working with OARestServlet that allows secure access to object model data.
4: Java implementation of the Java interface being remoted (java2java remote method call).

Includes an annotation checker that is useful for finding any configuration errors.

Author:

vvia

See Also:

OARestClass, OARestMethod, OARestParam annotations

Constructor Summary

Constructors

Constructor and Description
OARestClient() Create an OARestClient that can be used to call another server using HTTP.

Method Summary

Modifier and Type	Method and Description
protected OARestInvokeInfo	_onInvoke(Method method, Object[] args) Creates an OARestInvokeInfo to setup and manage a remote method call over HTTP
protected static void	_setupHttpsAccess()
OARestInvokeInfo	callEndPoint(OARestInvokeInfo ii, String httpMethod, String urlPath, String urlQuery, Map<String,Object> mapUrlQuery, String jsonBody, Map<String,Object> mapFormData) Call an HTTP endPoint.
void	callHttpEndPoint(OARestInvokeInfo invokeInfo)
String	callJsonEndpoint(String httpMethod, String urlPath, String query, String jsonBody) Manually call an HTTP end point using JSON and expecting JSON return value.
<T extends OAObject> OARestInvokeInfo	callOADelete(OARestInvokeInfo ii, T obj) call an OARestServlet to insert an object.
OARestInvokeInfo	callOAGet(OARestInvokeInfo ii, Class<? extends OAObject> clazz, Object id, Object id2, String... includePPs) call an OARestServlet to access an object with 2 part key, from an OAGraph.
OARestInvokeInfo	callOAGet(OARestInvokeInfo ii, Class<? extends OAObject> clazz, Object id, String... includePPs) call an OARestServlet to access an object from an OAGraph.
<T extends OAObject> OARestInvokeInfo	callOAInsert(OARestInvokeInfo ii, T obj, String... includePPs) call an OARestServlet to insert an object.
OARestInvokeInfo	callOASelect(OARestInvokeInfo ii, Class<? extends OAObject> clazz, String searchWhere, String searchOrderBy, String... includePPs) call an OARestServlet to access data in an OAGraph.
<T extends OAObject> OARestInvokeInfo	callOAUpdate(OARestInvokeInfo ii, T obj, String... includePPs) call an OARestServlet to update an object.
String	getBaseUrl()
String	getDefaultIdSeperator()
String	getDefaultOARestUrl()
<API> API	getInstance(Class<API> clazz) Used to create and instance of a Java interface that has been annotated using OARest* for the class, methods, and method parameters.
String	getProtocol()
OARestClassInfo	getRestClassInfo(Class interfaceClass) Get OARestClassInfo about an existing Java instance created from calling getInstance(class)
protected void	loadMetaData(Class interfaceClass) Used by getInstance to gather class/method/parameter metadata to be able to make an HTTP method call for each method in the Java interface.
protected Object	onInvoke(Method method, Object[] args) Manages any method that is called from a remote object.
void	setBaseUrl(String baseUrl)
void	setDefaultIdSeperator(String defaultIdSeperator)
void	setDefaultOARestUrl(String defaultOARestUrl)
void	setProtocol(String p)
static void	setupHttpsAccess() Configure HTTPS support.
void	setUserPw(String userId, String pw)
ArrayList<String>	verify(Class interfaceClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

OARestClient

public OARestClient()

Create an OARestClient that can be used to call another server using HTTP.

Method Detail

setUserPw

public void setUserPw(String userId,
                      String pw)

setBaseUrl

public void setBaseUrl(String baseUrl)

getBaseUrl

public String getBaseUrl()

setProtocol

public void setProtocol(String p)

getProtocol

public String getProtocol()

setDefaultOARestUrl

public void setDefaultOARestUrl(String defaultOARestUrl)

getDefaultOARestUrl

public String getDefaultOARestUrl()

setDefaultIdSeperator

public void setDefaultIdSeperator(String defaultIdSeperator)

getDefaultIdSeperator

public String getDefaultIdSeperator()

getInstance

public <API> API getInstance(Class<API> clazz)
                      throws Exception

Used to create and instance of a Java interface that has been annotated using OARest* for the class, methods, and method parameters.

This will use a Java proxy object to manage all of the method calls.

Parameters:

clazz - Java interface to create an instance of.

Throws:

Exception

onInvoke

protected Object onInvoke(Method method,
                          Object[] args)
                   throws Throwable

Manages any method that is called from a remote object.

Throws:

Throwable

_onInvoke

protected OARestInvokeInfo _onInvoke(Method method,
                                     Object[] args)
                              throws Throwable

Creates an OARestInvokeInfo to setup and manage a remote method call over HTTP

Throws:

Throwable

verify

public ArrayList<String> verify(Class interfaceClass)

getRestClassInfo

public OARestClassInfo getRestClassInfo(Class interfaceClass)

Get OARestClassInfo about an existing Java instance created from calling getInstance(class)

See Also:

to find any issues with the interface annotations and methods.

loadMetaData

protected void loadMetaData(Class interfaceClass)
                     throws Exception

Used by getInstance to gather class/method/parameter metadata to be able to make an HTTP method call for each method in the Java interface.

Throws:

Exception

callHttpEndPoint

public void callHttpEndPoint(OARestInvokeInfo invokeInfo)
                      throws Exception

Throws:

Exception

callJsonEndpoint

public String callJsonEndpoint(String httpMethod,
                               String urlPath,
                               String query,
                               String jsonBody)
                        throws Exception

Manually call an HTTP end point using JSON and expecting JSON return value.

Throws:

Exception

setupHttpsAccess

public static void setupHttpsAccess()
                             throws Exception

Configure HTTPS support.

Throws:

Exception

_setupHttpsAccess

protected static void _setupHttpsAccess()
                                 throws Exception

Throws:

Exception

callEndPoint

public OARestInvokeInfo callEndPoint(OARestInvokeInfo ii,
                                     String httpMethod,
                                     String urlPath,
                                     String urlQuery,
                                     Map<String,Object> mapUrlQuery,
                                     String jsonBody,
                                     Map<String,Object> mapFormData)
                              throws Exception

Call an HTTP endPoint.

Parameters:

ii - (optional) defines details about how to call the server.

httpMethod - ex: GET, POST, DELETE, etc

urlPath - url path to go with base url

urlQuery - url query

mapUrlQuery - name/value pairs for url query

jsonBody - JSON object(s) to send as http body

mapFormData -

Returns:

restInvokeInfo that defines the http call.

Throws:

Exception

callOASelect

public OARestInvokeInfo callOASelect(OARestInvokeInfo ii,
                                     Class<? extends OAObject> clazz,
                                     String searchWhere,
                                     String searchOrderBy,
                                     String... includePPs)
                              throws Exception

call an OARestServlet to access data in an OAGraph.

Parameters:

ii - (optional) defines details about how to call the server.

clazz - OAObject class that is being called.

searchWhere - object query search

searchOrderBy - sort order by

includePPs - extra property paths to include in the results.

Returns:

InvokeInfo with details (including JSON result)

Throws:

Exception

callOAGet

public OARestInvokeInfo callOAGet(OARestInvokeInfo ii,
                                  Class<? extends OAObject> clazz,
                                  Object id,
                                  String... includePPs)
                           throws Exception

call an OARestServlet to access an object from an OAGraph.

Parameters:

ii - (optional) defines details about how to call the server.

clazz - OAObject class that is being called.

id - the object key value of object.

includePPs - extra property paths to include in the results.

Returns:

InvokeInfo with details (including JSON result)

Throws:

Exception

callOAGet

public OARestInvokeInfo callOAGet(OARestInvokeInfo ii,
                                  Class<? extends OAObject> clazz,
                                  Object id,
                                  Object id2,
                                  String... includePPs)
                           throws Exception

call an OARestServlet to access an object with 2 part key, from an OAGraph.

Parameters:

ii - (optional) defines details about how to call the server.

clazz - OAObject class that is being called.

id - the object key value of object.

includePPs - extra property paths to include in the results.

Returns:

InvokeInfo with details (including JSON result)

Throws:

Exception

callOAInsert

public <T extends OAObject> OARestInvokeInfo callOAInsert(OARestInvokeInfo ii,
                                                          T obj,
                                                          String... includePPs)
                                                   throws Exception

call an OARestServlet to insert an object.

Parameters:

ii - (optional) defines details about how to call the server.

obj - object to insert.

includePPs - extra property paths to include in the results.

Returns:

InvokeInfo with details (including JSON result)

Throws:

Exception

callOADelete

public <T extends OAObject> OARestInvokeInfo callOADelete(OARestInvokeInfo ii,
                                                          T obj)
                                                   throws Exception

call an OARestServlet to insert an object.

Parameters:

ii - (optional) defines details about how to call the server.

obj - object to insert.

Returns:

InvokeInfo with details (including JSON result)

Throws:

Exception

callOAUpdate

public <T extends OAObject> OARestInvokeInfo callOAUpdate(OARestInvokeInfo ii,
                                                          T obj,
                                                          String... includePPs)
                                                   throws Exception

call an OARestServlet to update an object.

Parameters:

ii - (optional) defines details about how to call the server.

obj - object to update.

includePPs - extra property paths to include in the results.

Returns:

InvokeInfo with details (including JSON result)

Throws:

Exception