org.wso2.carbon.auth.rest.api.commons.util

Class RestApiUtil

java.lang.Object

org.wso2.carbon.auth.rest.api.commons.util.RestApiUtil

public class RestApiUtil
extends Object

Utility class for all REST APIs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_ALL_ORIGINS
static String	WEB_PROTOCOL_SUFFIX

Constructor Summary

Constructors

Constructor and Description
RestApiUtil()

Method Summary

Modifier and Type	Method and Description
static String	getAllowedOrigin(String origin)
static String	getApiPath(Method method)
static String	getDefinedMethodHeadersInSwaggerContent(org.wso2.msf4j.Request request, Method method) Get defined HTTP methods in the swagger definition as a comma separated string
static ErrorDTO	getErrorDTO(org.wso2.carbon.auth.core.exception.ExceptionCodeHandler exceptionCodeHandler) Returns an errorDTO based on a provided ExceptionCodeHandler
static ErrorDTO	getInternalServerErrorDTO() Returns an Internal Server Error DTO
static String	getLoggedInUsername(org.wso2.msf4j.Request request) Get the current logged in user's username
static Map<String,Integer>	getPaginationParams(Integer offset, Integer limit, Integer total) Returns the next/previous offset/limit parameters properly when current offset, limit and size parameters are specified

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WEB_PROTOCOL_SUFFIX

public static final String WEB_PROTOCOL_SUFFIX

See Also:

Constant Field Values

ALLOW_ALL_ORIGINS

public static final String ALLOW_ALL_ORIGINS

See Also:

Constant Field Values

Constructor Detail

RestApiUtil

public RestApiUtil()

Method Detail

getLoggedInUsername

public static String getLoggedInUsername(org.wso2.msf4j.Request request)

Get the current logged in user's username

Parameters:

request - msf4j request

Returns:

The current logged in user's username or null if user is not logged in.

getInternalServerErrorDTO

public static ErrorDTO getInternalServerErrorDTO()

Returns an Internal Server Error DTO

Returns:

an Internal Server Error DTO

getErrorDTO

public static ErrorDTO getErrorDTO(org.wso2.carbon.auth.core.exception.ExceptionCodeHandler exceptionCodeHandler)

Returns an errorDTO based on a provided ExceptionCodeHandler

Parameters:

exceptionCodeHandler - with mapped HTTP error details

Returns:

An errorDTO with the specified details

getPaginationParams

public static Map<String,Integer> getPaginationParams(Integer offset,
                                                      Integer limit,
                                                      Integer total)

Returns the next/previous offset/limit parameters properly when current offset, limit and size parameters are specified

Parameters:

offset - current starting index

limit - current max records

total - maximum index possible

Returns:

the next/previous offset/limit parameters as a hash-map

getAllowedOrigin

public static String getAllowedOrigin(String origin)

getDefinedMethodHeadersInSwaggerContent

public static String getDefinedMethodHeadersInSwaggerContent(org.wso2.msf4j.Request request,
                                                             Method method)
                                                      throws org.wso2.carbon.auth.core.exception.AuthException

Get defined HTTP methods in the swagger definition as a comma separated string

Parameters:

request - Request

method - Method information for the request

Returns:

Http Methods as a comma separated string

Throws:

org.wso2.carbon.auth.core.exception.AuthException - if failed to get defined http methods

getApiPath

public static String getApiPath(Method method)