Field Detail

• private static final org.apache.logging.log4j.Logger LOG

• private static final java.util.regex.Pattern cmdUrlPattern

• private static final java.util.regex.Pattern cmdUrlPattern2

• private static final java.util.Map<java.lang.String, java.lang.reflect.Method> methodMap

• private final javax.servlet.ServletConfig servletConfig

Constructor Detail

• ConfigurationProvider(javax.servlet.ServletConfig servletConfig)

Method Detail

• static T[] arrayBuilder(java.lang.Class<T> classToCastTo, java.util.Collection c)

  Convert Collection to a Java (typed) array [].

  Returns:

  Array of the type (T) containing the items from collection 'c'.

  Parameters:

  classToCastTo - array type (Object[], Person[], etc.)

  c - Collection containing items to be placed into the array.

  - Type of the array

• Envelope callController(javax.servlet.http.HttpServletRequest request, java.lang.String json)

  Read the JSON request (susceptible to Exceptions that are allowed to be thrown from here), and then call the appropriate Controller method. The controller method exceptions are caught and returned carefully as JSON error String responses. Note, this should not happen - if they do, it is a case of a missing try/catch handler in a Controller method. Troll the logs to find these and fix them as they come up.

• private static java.lang.Object callMethod(java.lang.reflect.Method method, java.lang.Object target, java.lang.Object[] args)

  Invoke the passed in method, on the passed in target, with the passed in arguments.

  Returns:

  Object the value return from the invoked method.

  Parameters:

  method - Method to be invoked

  target - instance which contains the method

  args - Object[] of values which line up to the method arguments.

• private static java.lang.Object[] convertArgs(java.lang.reflect.Method method, java.lang.Object[] args)

  Convert the passed in arguments to match the arguments of the passed in method.

  Returns:

  Object[] of converted values. The original values from args[], will be converted to match the argument types in the method. Java-util's Converter.convert() handles the primitive and simple types (date, etc.). Collections and Arrays will be converted to match the respective argument type, and Maps will be converted to classes (if the matching argument is not a Map). This is done by bring the Class type of the argument into the json-io JsonObject which represents the instance of the class.

  Parameters:

  method - Method which contains argument types.

  args - Object[] of values, which need to be converted.

• static java.lang.Object getArguments(java.lang.String json, java.lang.String controllerName, java.lang.String methodName)

  Build the argument list from the passed in json

  Returns:

  Object[] of arguments to be passed to method, or Envelope if an error occurred.

  Parameters:

  json - String argument lists

  controllerName - String name of controller

  methodName - String name of method to call on the controller

• protected java.lang.Object getController(java.lang.String name)

  Fetch the controller with the given name.

  name:

  String name of controller to fetch

  Returns:

  Object controller instance registered with the given name. The controller could be registered as a Spring Bean or an n-cube.

• protected java.lang.String getLogPrefix()

  Returns:

  String prefix to append to log so that we can tell what controller type was used (spring:, ncube:, etc.)

• private static java.lang.Object getMethod(java.lang.Object controller, java.lang.String controllerName, java.lang.String methodName, int argCount)

  Fetch the named method from the controller. First a local cache will be checked, and if not found, the method will be found reflectively on the controller. If the method is found, then it will be checked for a ControllerMethod annotation, which can indicate that it is NOT allowed to be called. This permits a public controller method to be blocked from remote access.

  Parameters:

  controller - Object on which the named method will be found.

  controllerName - String name of the controller (Spring name, n-cube name, etc.)

  methodName - String name of method to be located on the controller.

  argCount - int number of arguments. This is used as part of the cache key to allow for duplicate method names as long as the argument list length is different.

• private static java.lang.reflect.Method getMethod(java.lang.Class c, java.lang.String name, int argc)

  Reflectively find the requested method on the requested class.

  Returns:

  Method instance located on the passed in class.

  Parameters:

  c - Class containing the method

  name - String method name

  argc - int number of arguments

• javax.servlet.ServletConfig getServletConfig()

• static java.util.regex.Matcher getUrlMatcher(javax.servlet.http.HttpServletRequest request)

  Get a regex Matcher that matches the URL String for /context/controller/method

  Returns:

  Matcher that pattern matches the URL or

  Parameters:

  request - HttpServletRequest passed to the command servlet.

  json - String arguments in JSON form from HTTP request

• protected boolean isMethodAllowed(java.lang.String methodName)

  Verify that the passed in method is allowed to be called remotely.

  Returns:

  boolean true if ok, false otherwise.

  Parameters:

  methodName - String method name to check