| Modifier and Type | Method and Description |
|---|---|
RamlActionType |
ApiActionMetadata.getActionType() |
| Modifier and Type | Method and Description |
|---|---|
void |
ApiResourceMetadata.addApiCall(RamlResource resource,
RamlActionType actionType,
RamlAction action) |
void |
ApiResourceMetadata.addApiCall(RamlResource resource,
RamlActionType actionType,
RamlAction action,
String responseContentType,
boolean injectHttpHeadersParameter) |
void |
ApiActionMetadata.setActionType(RamlActionType actionType) |
| Constructor and Description |
|---|
ApiActionMetadata(ApiResourceMetadata parent,
RamlResource resource,
RamlActionType actionType,
RamlAction action) |
ApiActionMetadata(ApiResourceMetadata parent,
RamlResource resource,
RamlActionType actionType,
RamlAction action,
String responseContentTypeFilter,
boolean injectHttpHeadersParameter) |
| Modifier and Type | Method and Description |
|---|---|
static String |
NamingHelper.getActionName(RamlResource controllerizedResource,
RamlResource resource,
RamlAction action,
RamlActionType actionType)
Attempts to infer the name of an action (intent) from a resource's relative URL and action details
|
| Modifier and Type | Method and Description |
|---|---|
protected Map<RamlActionType,String> |
SpringMvcResourceParser.getHttpMethodAndName(Class<?> clazz,
Method method) |
protected abstract Map<RamlActionType,String> |
ResourceParser.getHttpMethodAndName(Class<?> clazz,
Method method)
Extracts the http method (verb) as well as the name of the api call
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
SpringMvcResourceParser.addHeadersForMethod(RamlAction action,
RamlActionType actionType,
Method method) |
protected abstract void |
ResourceParser.addHeadersForMethod(RamlAction action,
RamlActionType actionType,
Method method)
Allows children to add common headers to API methods (eg CSRF, Authorization)
|
static boolean |
ResourceParser.doesActionTypeSupportMultipartMime(RamlActionType target)
Method to check if a specific action type supports multipart mime request
|
static boolean |
ResourceParser.doesActionTypeSupportRequestBody(RamlActionType target)
Method to check if a specific action type supports payloads in the body of the request
|
protected Map<String,RamlQueryParameter> |
ResourceParser.extractQueryParameters(RamlActionType apiAction,
Method method,
Map<String,String> parameterComments)
Extracts parameters from a method call and attaches these with the comments extracted from the javadoc
|
protected Map<String,RamlMimeType> |
ResourceParser.extractRequestBodyFromMethod(RamlActionType apiAction,
Method method,
Map<String,String> parameterComments)
Extracts the TOs and other parameters from a method and will convert into JsonSchema for inclusion in the body
TODO refactor this code structure
|
| Modifier and Type | Method and Description |
|---|---|
RamlActionType |
RamlModelFactory.createRamlActionType(Object type) |
RamlActionType |
RamlAction.getType() |
static RamlActionType |
RamlActionType.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static RamlActionType[] |
RamlActionType.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
| Modifier and Type | Method and Description |
|---|---|
Map<RamlActionType,RamlAction> |
RamlResource.getActions() |
| Modifier and Type | Method and Description |
|---|---|
void |
RamlResource.addAction(RamlActionType apiAction,
RamlAction action) |
RamlAction |
RamlResource.getAction(RamlActionType actionType) |
void |
RamlAction.setType(RamlActionType actionType) |
| Modifier and Type | Method and Description |
|---|---|
void |
RamlResource.addActions(Map<RamlActionType,RamlAction> actions) |
| Modifier and Type | Method and Description |
|---|---|
RamlActionType |
RJP08V1RamlModelFactory.createRamlActionType(Object type) |
RamlActionType |
RJP08V1RamlAction.getType() |
| Modifier and Type | Method and Description |
|---|---|
Map<RamlActionType,RamlAction> |
RJP08V1RamlResource.getActions() |
| Modifier and Type | Method and Description |
|---|---|
void |
RJP08V1RamlResource.addAction(RamlActionType actionType,
RamlAction action) |
RamlAction |
RJP08V1RamlResource.getAction(RamlActionType actionType) |
void |
RJP08V1RamlAction.setType(RamlActionType actionType) |
| Modifier and Type | Method and Description |
|---|---|
void |
RJP08V1RamlResource.addActions(Map<RamlActionType,RamlAction> newActions) |
| Modifier and Type | Method and Description |
|---|---|
Set<StyleIssue> |
RamlStyleCheckerAdapter.checkActionStyle(RamlActionType key,
RamlAction value,
IssueLocation location,
RamlRoot raml) |
Set<StyleIssue> |
RamlStyleChecker.checkActionStyle(RamlActionType key,
RamlAction value,
IssueLocation location,
RamlRoot raml)
Check the style of a particular action
|
| Modifier and Type | Method and Description |
|---|---|
Set<StyleIssue> |
ResponseCodeDefinitionStyleChecker.checkActionStyle(RamlActionType key,
RamlAction value,
IssueLocation location,
RamlRoot raml) |
Set<StyleIssue> |
ResponseBodySchemaStyleChecker.checkActionStyle(RamlActionType key,
RamlAction value,
IssueLocation location,
RamlRoot raml) |
Set<StyleIssue> |
RequestBodySchemaStyleChecker.checkActionStyle(RamlActionType key,
RamlAction value,
IssueLocation location,
RamlRoot raml) |
Set<StyleIssue> |
ActionSecurityResponseChecker.checkActionStyle(RamlActionType key,
RamlAction value,
IssueLocation location,
RamlRoot raml) |
| Modifier and Type | Method and Description |
|---|---|
Pair<Set<Issue>,Set<Issue>> |
RamlActionVisitorCheck.check(RamlActionType name,
RamlAction reference,
RamlAction target,
IssueLocation location,
IssueSeverity maxSeverity)
Checks a particular action
|
| Modifier and Type | Method and Description |
|---|---|
Pair<Set<Issue>,Set<Issue>> |
ActionResponseBodySchemaChecker.check(RamlActionType name,
RamlAction reference,
RamlAction target,
IssueLocation location,
IssueSeverity maxSeverity) |
Pair<Set<Issue>,Set<Issue>> |
ActionQueryParameterChecker.check(RamlActionType name,
RamlAction reference,
RamlAction target,
IssueLocation location,
IssueSeverity maxSeverity) |
Pair<Set<Issue>,Set<Issue>> |
ActionContentTypeChecker.check(RamlActionType name,
RamlAction reference,
RamlAction target,
IssueLocation location,
IssueSeverity maxSeverity) |
Copyright © 2017. All rights reserved.