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.

Constructor Summary

Constructors

Constructor and Description
RestApiUtil()

Method Summary

Modifier and Type	Method and Description
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

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