SpringConfigurationProvider (Groovy Documentation)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

com.cedarsoftware.servlet.SpringConfigurationProvider

Spring configuration provider for the JsonCommandServlet. This provider will find controllers using AppCtx.getBean(), locating controller by name. It will then invoke the request method with the requested arguments on the controller. All appropriate error handling is performed.
Authors:
John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License") you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields
Modifiers	Name	Description
`private static org.apache.logging.log4j.Logger`	`LOG`
`private org.springframework.context.ApplicationContext`	`springAppCtx`

Inherited fields
Fields inherited from class	Fields
`class ConfigurationProvider`	`LOG, cmdUrlPattern, cmdUrlPattern2, methodMap, servletConfig`

Constructor Summary

Constructors
Constructor and description
`SpringConfigurationProvider (javax.servlet.ServletConfig servletConfig)`

Methods Summary

Methods
Type	Name and description
`protected java.lang.Object`	`getController(java.lang.String name)` @param name String name of a Controller instance (Spring bean name, n-cube name, etc).
`protected java.lang.String`	`getLogPrefix()` @return String 'spring' to indicate that a Spring controller was used.
`protected boolean`	`isMethodAllowed(java.lang.String methodName)` All controller methods are allowed by default.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ConfigurationProvider`	`arrayBuilder, callController, callMethod, convertArgs, getArguments, getController, getLogPrefix, getMethod, getMethod, getServletConfig, getUrlMatcher, isMethodAllowed`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - private static final org.apache.logging.log4j.Logger LOG
  - private final org.springframework.context.ApplicationContext springAppCtx
- Constructor Detail
  - SpringConfigurationProvider(javax.servlet.ServletConfig servletConfig)
- Method Detail
  - protected java.lang.Object getController(java.lang.String name)
    
    Returns:
    Controller instance if successful, otherwise an error Envelope instance is returned with the appropriate error message already filled in, and the status set to false.
    Parameters:
    name - String name of a Controller instance (Spring bean name, n-cube name, etc).
  - protected java.lang.String getLogPrefix()
    
    Returns:
    String 'spring' to indicate that a Spring controller was used.
  - protected boolean isMethodAllowed(java.lang.String methodName)
    
    All controller methods are allowed by default. They can be turned off by making them either not public -or- using the annotation @ControllerMethod(allow = false)}
    Returns:
    true if the method can be called, false otherwise.
    Parameters:
    methodName - String method name to check.

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation