org.bonitasoft.engine.api.permission

Class APICallContext

java.lang.Object

org.bonitasoft.engine.api.permission.APICallContext

All Implemented Interfaces:

Serializable

public class APICallContext
extends Object
implements Serializable

Context of a call made on a REST API

Author:

Baptiste Mesta

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELIMITER
static String	FILTER_KEY
static String	SEARCH_TERM_KEY

Constructor Summary

Constructors

Constructor and Description
APICallContext() empty constructor
APICallContext(String method, String apiName, String resourceName, String resourceId)
APICallContext(String method, String apiName, String resourceName, String resourceId, String queryString, String body)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getApiName()
String	getBody()
List<String>	getCompoundResourceId()
Map<String,String>	getFilters()
String	getMethod()
String	getQueryString()
String	getResourceId()
String	getResourceName()
String	getSearchTerm()
int	hashCode()
boolean	isDELETE()
boolean	isGET()
boolean	isPOST()
boolean	isPUT()
void	setApiName(String apiName)
void	setBody(String body)
void	setMethod(String method)
void	setQueryString(String queryString)
void	setResourceId(String resourceId)
void	setResourceName(String resourceName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FILTER_KEY

public static final String FILTER_KEY

See Also:

Constant Field Values

SEARCH_TERM_KEY

public static final String SEARCH_TERM_KEY

See Also:

Constant Field Values

DELIMITER

public static final String DELIMITER

See Also:

Constant Field Values

Constructor Detail

APICallContext

public APICallContext(String method,
              String apiName,
              String resourceName,
              String resourceId)

Parameters:

method - the HTTP method

apiName - the name of the api

resourceName - the name of the resource

resourceId - the id (or multiple id) of the resource if specified

APICallContext

public APICallContext(String method,
              String apiName,
              String resourceName,
              String resourceId,
              String queryString,
              String body)

Parameters:

method - the HTTP method

apiName - the name of the api

resourceName - the name of the resource

resourceId - the id (or multiple id) of the resource if specified

queryString - the query string of the api context if specified

body - the body string of the api context if specified

APICallContext

public APICallContext()

empty constructor

Method Detail

getMethod

public String getMethod()

isGET

public boolean isGET()

Returns:

true if method is GET

isPUT

public boolean isPUT()

Returns:

true if method is PUT

isPOST

public boolean isPOST()

Returns:

true if method is POST

isDELETE

public boolean isDELETE()

Returns:

true if method is DELETE

setMethod

public void setMethod(String method)

getApiName

public String getApiName()

setApiName

public void setApiName(String apiName)

getResourceName

public String getResourceName()

setResourceName

public void setResourceName(String resourceName)

getCompoundResourceId

public List<String> getCompoundResourceId()

getResourceId

public String getResourceId()

setResourceId

public void setResourceId(String resourceId)

getQueryString

public String getQueryString()

setQueryString

public void setQueryString(String queryString)

getBody

public String getBody()

setBody

public void setBody(String body)

getFilters

public Map<String,String> getFilters()

getSearchTerm

public String getSearchTerm()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object