java.lang.Object
- org.actioncontroller.ApiControllerMethodAction

All Implemented Interfaces:

ApiControllerAction
```
public class ApiControllerMethodAction
extends Object
implements ApiControllerAction
```
Represents a single action that can be performed on a controller. An action is defined on the http-end as a http method and a path template, and on the Java-side as a method on the controller class. For example @Get("/helloWorld") public String hello(@RequestParam("greeter") String greeter) defines an action that responds to GET /helloWorld?greeter=something with a string.

Field Summary

Fields
Modifier and Type Field Description

static Pattern PATH_PARAM_PATTERN

Constructor Summary

Constructors
Constructor	Description
`ApiControllerMethodAction(String httpMethod, String pattern, Object controller, Method action, ApiControllerContext context)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`calculatePathParams(ApiHttpExchange exchange)`
`Method`	`getAction()`	Returns the method that implements this action
`Object`	`getController()`	Returns the controller that this action belongs to
`String`	`getHttpMethod()`	Returns the request HTTP Method used to match this action
`String`	`getMethodName()`
`Pattern[]`	`getParamRegexp()`	Returns an sparse array with the element of the path specification that are parameterized
`String`	`getPattern()`	Returns the request URL pattern used to match this action
`String[]`	`getPatternParts()`	Returns an array with each element of the path specification
`protected Optional<String>`	`getRequiredUserRole()`
`protected Object`	`invoke(Object controller, Method action, Object[] arguments)`	Invoke the method on the controller with the given parameters and translate exceptions to http status codes
`void`	`invoke(UserContext userContext, ApiHttpExchange exchange)`	Invokes this action on the given `ApiHttpExchange` by converting the exchange to method invocation arguments, invoking the method and converting the return value.
`boolean`	`matches(ApiControllerAction otherAction)`	Returns true if the actions respond to the same routes
`boolean`	`matchesRequiredParameters(ApiHttpExchange exchange)`	Returns true if the exchange has all the required query parameters specified in this action, or if there are no required query parameters in the action
`boolean`	`requiresParameter()`	Returns true if the action requires a request parameter, such as `@Get("/test?error")`.
`String`	`toString()`
`protected void`	`verifyUserAccess(ApiHttpExchange exchange, UserContext userContext)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PATH_PARAM_PATTERN
```
public static final Pattern PATH_PARAM_PATTERN
```
- Constructor Detail
  - ApiControllerMethodAction
```
public ApiControllerMethodAction(String httpMethod,
                                 String pattern,
                                 Object controller,
                                 Method action,
                                 ApiControllerContext context)
```
- Method Detail
  - getController
```
public Object getController()
```
    Description copied from interface: ApiControllerAction
    
    Returns the controller that this action belongs to
    
    Specified by:
    
    getController in interface ApiControllerAction
  - getAction
```
public Method getAction()
```
    Description copied from interface: ApiControllerAction
    
    Returns the method that implements this action
    
    Specified by:
    
    getAction in interface ApiControllerAction
  - getPattern
```
public String getPattern()
```
    Description copied from interface: ApiControllerAction
    
    Returns the request URL pattern used to match this action
    
    Specified by:
    
    getPattern in interface ApiControllerAction
  - getHttpMethod
```
public String getHttpMethod()
```
    Description copied from interface: ApiControllerAction
    
    Returns the request HTTP Method used to match this action
    
    Specified by:
    
    getHttpMethod in interface ApiControllerAction
  - requiresParameter
```
public boolean requiresParameter()
```
    Description copied from interface: ApiControllerAction
    
    Returns true if the action requires a request parameter, such as @Get("/test?error"). When more than one action returns true from ApiControllerAction.matches(org.actioncontroller.ApiControllerAction) and exactly one action returns true from requiresParameter, that action is invokes. Otherwise action-controller throws an exception
    
    Specified by:
    
    requiresParameter in interface ApiControllerAction
  - matchesRequiredParameters
```
public boolean matchesRequiredParameters(ApiHttpExchange exchange)
```
    Description copied from interface: ApiControllerAction
    
    Returns true if the exchange has all the required query parameters specified in this action, or if there are no required query parameters in the action
    
    Specified by:
    
    matchesRequiredParameters in interface ApiControllerAction
  - getPatternParts
```
public String[] getPatternParts()
```
    Description copied from interface: ApiControllerAction
    
    Returns an array with each element of the path specification
    
    Specified by:
    
    getPatternParts in interface ApiControllerAction
  - getParamRegexp
```
public Pattern[] getParamRegexp()
```
    Description copied from interface: ApiControllerAction
    
    Returns an sparse array with the element of the path specification that are parameterized
    
    Specified by:
    
    getParamRegexp in interface ApiControllerAction
  - matches
```
public boolean matches(ApiControllerAction otherAction)
```
    Description copied from interface: ApiControllerAction
    
    Returns true if the actions respond to the same routes
    
    Specified by:
    
    matches in interface ApiControllerAction
  - invoke
```
public void invoke(UserContext userContext,
                   ApiHttpExchange exchange)
            throws IOException
```
    Description copied from interface: ApiControllerAction
    
    Invokes this action on the given ApiHttpExchange by converting the exchange to method invocation arguments, invoking the method and converting the return value.
    
    Specified by:
    
    invoke in interface ApiControllerAction
    
    Throws:
    
    IOException
  - calculatePathParams
```
protected void calculatePathParams(ApiHttpExchange exchange)
```
  - invoke
```
protected Object invoke(Object controller,
                        Method action,
                        Object[] arguments)
```
    Invoke the method on the controller with the given parameters and translate exceptions to http status codes
  - verifyUserAccess
```
protected void verifyUserAccess(ApiHttpExchange exchange,
                                UserContext userContext)
```
  - getRequiredUserRole
```
protected Optional<String> getRequiredUserRole()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getMethodName
```
public String getMethodName()
```
    Specified by:
    
    getMethodName in interface ApiControllerAction

Class ApiControllerMethodAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH_PARAM_PATTERN

Constructor Detail

ApiControllerMethodAction

Method Detail

getController

getAction

getPattern

getHttpMethod

requiresParameter

matchesRequiredParameters

getPatternParts

getParamRegexp

matches

invoke

calculatePathParams

invoke

verifyUserAccess

getRequiredUserRole

toString

getMethodName