org.glassfish.admingui.common.util
Class RestUtil

java.lang.Object
  org.glassfish.admingui.common.util.RestUtil

public class RestUtil
extends java.lang.Object

Author:

anilam

Field Summary

static java.lang.String	FORM_ENCODING
static java.lang.String	GUI_TOKEN_FOR_EMPTY_PROPERTY_VALUE
static com.sun.jersey.api.client.Client	JERSEY_CLIENT
static java.lang.String	RESPONSE_TYPE

Constructor Summary

RestUtil()

Method Summary

static java.lang.String	appendEncodedSegment(java.lang.String base, java.lang.String segment) This method will encode append segment to base, encoding it so that a correct URL is returned.
static java.util.List<java.util.Map>	buildChildEntityList(java.lang.String parent, java.lang.String childType, java.util.List skipList, java.util.List includeList, java.lang.String id) Given the parent URL and the desired childType, this method will build a List of Maps that contains each child entities values.
static java.util.Map<java.lang.String,java.lang.String>	buildDefaultValueMap(java.lang.String endpoint)
protected static javax.ws.rs.core.MultivaluedMap	buildMultivalueMap(java.util.Map<java.lang.String,java.lang.Object> payload)
protected static java.util.Map	buildUseOnlyAttrMap(java.util.Map<java.lang.String,java.lang.Object> attrs, java.util.List<java.lang.String> onlyUseAttrs)
static void	checkStatusForSuccess(com.sun.jersey.api.client.ClientResponse cr)
protected static java.util.Map<java.lang.String,java.lang.Object>	convertNullValuesToFalse(java.util.Map<java.lang.String,java.lang.Object> attrs, java.util.List<java.lang.String> convertToFalse)
static RestResponse	delete(java.lang.String address, java.util.Map<java.lang.String,java.lang.Object> payload)
static java.lang.Boolean	doesProxyExist(java.lang.String endpoint)
protected static java.util.Map<java.lang.String,java.lang.Object>	fixKeyNames(java.util.Map<java.lang.String,java.lang.Object> map)
static RestResponse	get(java.lang.String address)
static RestResponse	get(java.lang.String address, java.util.Map<java.lang.String,java.lang.Object> payload)
static java.util.Map	getAttributesMap(java.lang.String endpoint)
static java.util.List<java.lang.String>	getChildList(java.lang.String endpoint) Given the parent URL and the desired childType, this method will build a List of Strings that contains child entity names.
static java.util.Map<java.lang.String,java.lang.String>	getChildMap(java.lang.String endpoint)
static java.util.List<java.lang.String>	getChildResourceList(java.lang.String document)
static java.util.Map<java.lang.String,java.lang.Object>	getEntityAttrs(java.lang.String endpoint, java.lang.String key)
static java.lang.String	getPropValue(java.lang.String endpoint, java.lang.String propName, com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)
static void	getRestRequestFromServlet(javax.servlet.http.HttpServletRequest request, java.lang.String endpoint, java.util.Map<java.lang.String,java.lang.Object> attrs, boolean quiet, boolean throwException)
static boolean	hasWarning(java.util.Map responseMap)
static void	initialize(com.sun.jersey.api.client.Client client)
static java.util.Map	maskOffPassword(java.util.Map<java.lang.String,java.lang.Object> attrs)
static RestResponse	options(java.lang.String address, java.lang.String responseType)
static java.util.Map<java.lang.String,java.lang.Object>	parseResponse(RestResponse response, com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx, java.lang.String endpoint, java.lang.Object attrs, boolean quiet, boolean throwException)
static RestResponse	post(java.lang.String address, java.util.Map<java.lang.String,java.lang.Object> payload)
static RestResponse	post(java.lang.String address, java.lang.Object payload, java.lang.String contentType)
static void	postRestRequestFromServlet(javax.servlet.http.HttpServletRequest request, java.lang.String endpoint, java.util.Map<java.lang.String,java.lang.Object> attrs, boolean quiet, boolean throwException)
static RestResponse	put(java.lang.String address, java.util.Map<java.lang.String,java.lang.Object> payload)
protected static void	removeSpecifiedAttrs(java.util.Map<java.lang.String,java.lang.Object> attrs, java.util.List<java.lang.String> removeList)
static java.lang.String	resolveToken(java.lang.String endpoint, java.lang.String token)
static java.util.Map<java.lang.String,java.lang.Object>	restRequest(java.lang.String endpoint, java.util.Map<java.lang.String,java.lang.Object> attrs, java.lang.String method, com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx, boolean quiet)
static java.util.Map<java.lang.String,java.lang.Object>	restRequest(java.lang.String endpoint, java.util.Map<java.lang.String,java.lang.Object> attrs, java.lang.String method, com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx, boolean quiet, boolean throwException)
static RestResponse	sendCreateRequest(java.lang.String endpoint, java.util.Map<java.lang.String,java.lang.Object> attrs, java.util.List<java.lang.String> skipAttrs, java.util.List<java.lang.String> onlyUseAttrs, java.util.List<java.lang.String> convertToFalse)
static RestResponse	sendUpdateRequest(java.lang.String endpoint, java.util.Map<java.lang.String,java.lang.Object> attrs, java.util.List<java.lang.String> skipAttrs, java.util.List<java.lang.String> onlyUseAttrs, java.util.List<java.lang.String> convertToFalse)
static java.lang.String	upperCaseFirstLetter(java.lang.String string) Converts the first letter of the given string to Uppercase.

Methods inherited from class java.lang.Object

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

Field Detail

FORM_ENCODING

public static final java.lang.String FORM_ENCODING

See Also:

Constant Field Values

RESPONSE_TYPE

public static final java.lang.String RESPONSE_TYPE

See Also:

Constant Field Values

GUI_TOKEN_FOR_EMPTY_PROPERTY_VALUE

public static final java.lang.String GUI_TOKEN_FOR_EMPTY_PROPERTY_VALUE

See Also:

Constant Field Values

JERSEY_CLIENT

public static final com.sun.jersey.api.client.Client JERSEY_CLIENT

Constructor Detail

RestUtil

public RestUtil()

Method Detail

getPropValue

public static java.lang.String getPropValue(java.lang.String endpoint,
                                            java.lang.String propName,
                                            com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)

resolveToken

public static java.lang.String resolveToken(java.lang.String endpoint,
                                            java.lang.String token)

restRequest

public static java.util.Map<java.lang.String,java.lang.Object> restRequest(java.lang.String endpoint,
                                                                           java.util.Map<java.lang.String,java.lang.Object> attrs,
                                                                           java.lang.String method,
                                                                           com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx,
                                                                           boolean quiet)

restRequest

public static java.util.Map<java.lang.String,java.lang.Object> restRequest(java.lang.String endpoint,
                                                                           java.util.Map<java.lang.String,java.lang.Object> attrs,
                                                                           java.lang.String method,
                                                                           com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx,
                                                                           boolean quiet,
                                                                           boolean throwException)

maskOffPassword

public static java.util.Map maskOffPassword(java.util.Map<java.lang.String,java.lang.Object> attrs)

buildDefaultValueMap

public static java.util.Map<java.lang.String,java.lang.String> buildDefaultValueMap(java.lang.String endpoint)
                                                                             throws javax.xml.parsers.ParserConfigurationException,
                                                                                    org.xml.sax.SAXException,
                                                                                    java.io.IOException

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getAttributesMap

public static java.util.Map getAttributesMap(java.lang.String endpoint)

getEntityAttrs

public static java.util.Map<java.lang.String,java.lang.Object> getEntityAttrs(java.lang.String endpoint,
                                                                              java.lang.String key)

parseResponse

public static java.util.Map<java.lang.String,java.lang.Object> parseResponse(RestResponse response,
                                                                             com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx,
                                                                             java.lang.String endpoint,
                                                                             java.lang.Object attrs,
                                                                             boolean quiet,
                                                                             boolean throwException)

hasWarning

public static boolean hasWarning(java.util.Map responseMap)

appendEncodedSegment

public static java.lang.String appendEncodedSegment(java.lang.String base,
                                                    java.lang.String segment)

This method will encode append segment to base, encoding it so that a correct URL is returned.

Parameters:

base -

segment -

Returns:

buildMultivalueMap

protected static javax.ws.rs.core.MultivaluedMap buildMultivalueMap(java.util.Map<java.lang.String,java.lang.Object> payload)

sendCreateRequest

public static RestResponse sendCreateRequest(java.lang.String endpoint,
                                             java.util.Map<java.lang.String,java.lang.Object> attrs,
                                             java.util.List<java.lang.String> skipAttrs,
                                             java.util.List<java.lang.String> onlyUseAttrs,
                                             java.util.List<java.lang.String> convertToFalse)

sendUpdateRequest

public static RestResponse sendUpdateRequest(java.lang.String endpoint,
                                             java.util.Map<java.lang.String,java.lang.Object> attrs,
                                             java.util.List<java.lang.String> skipAttrs,
                                             java.util.List<java.lang.String> onlyUseAttrs,
                                             java.util.List<java.lang.String> convertToFalse)

fixKeyNames

protected static java.util.Map<java.lang.String,java.lang.Object> fixKeyNames(java.util.Map<java.lang.String,java.lang.Object> map)

removeSpecifiedAttrs

protected static void removeSpecifiedAttrs(java.util.Map<java.lang.String,java.lang.Object> attrs,
                                           java.util.List<java.lang.String> removeList)

buildUseOnlyAttrMap

protected static java.util.Map buildUseOnlyAttrMap(java.util.Map<java.lang.String,java.lang.Object> attrs,
                                                   java.util.List<java.lang.String> onlyUseAttrs)

convertNullValuesToFalse

protected static java.util.Map<java.lang.String,java.lang.Object> convertNullValuesToFalse(java.util.Map<java.lang.String,java.lang.Object> attrs,
                                                                                           java.util.List<java.lang.String> convertToFalse)

upperCaseFirstLetter

public static java.lang.String upperCaseFirstLetter(java.lang.String string)

Converts the first letter of the given string to Uppercase.

Parameters:

string - the input string

Returns:

the string with the Uppercase first letter

getChildResourceList

public static java.util.List<java.lang.String> getChildResourceList(java.lang.String document)
                                                             throws org.xml.sax.SAXException,
                                                                    java.io.IOException,
                                                                    javax.xml.parsers.ParserConfigurationException

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

buildChildEntityList

public static java.util.List<java.util.Map> buildChildEntityList(java.lang.String parent,
                                                                 java.lang.String childType,
                                                                 java.util.List skipList,
                                                                 java.util.List includeList,
                                                                 java.lang.String id)
                                                          throws java.lang.Exception

Given the parent URL and the desired childType, this method will build a List of Maps that contains each child entities values. In addition to the entity values, each row will have a field, 'selected', set to false, as well as the URL encoded entity name ('encodedName').

Parameters:

parent -

childType -

skipList -

Returns:

Throws:

java.lang.Exception

getChildList

public static java.util.List<java.lang.String> getChildList(java.lang.String endpoint)
                                                     throws java.lang.Exception

Given the parent URL and the desired childType, this method will build a List of Strings that contains child entity names.

Parameters:

endpoint -

Returns:

Throws:

java.lang.Exception

getChildMap

public static java.util.Map<java.lang.String,java.lang.String> getChildMap(java.lang.String endpoint)
                                                                    throws java.lang.Exception

Throws:

java.lang.Exception

doesProxyExist

public static java.lang.Boolean doesProxyExist(java.lang.String endpoint)

postRestRequestFromServlet

public static void postRestRequestFromServlet(javax.servlet.http.HttpServletRequest request,
                                              java.lang.String endpoint,
                                              java.util.Map<java.lang.String,java.lang.Object> attrs,
                                              boolean quiet,
                                              boolean throwException)

getRestRequestFromServlet

public static void getRestRequestFromServlet(javax.servlet.http.HttpServletRequest request,
                                             java.lang.String endpoint,
                                             java.util.Map<java.lang.String,java.lang.Object> attrs,
                                             boolean quiet,
                                             boolean throwException)

get

public static RestResponse get(java.lang.String address)

get

public static RestResponse get(java.lang.String address,
                               java.util.Map<java.lang.String,java.lang.Object> payload)

post

public static RestResponse post(java.lang.String address,
                                java.lang.Object payload,
                                java.lang.String contentType)

post

public static RestResponse post(java.lang.String address,
                                java.util.Map<java.lang.String,java.lang.Object> payload)

put

public static RestResponse put(java.lang.String address,
                               java.util.Map<java.lang.String,java.lang.Object> payload)

delete

public static RestResponse delete(java.lang.String address,
                                  java.util.Map<java.lang.String,java.lang.Object> payload)

options

public static RestResponse options(java.lang.String address,
                                   java.lang.String responseType)

checkStatusForSuccess

public static void checkStatusForSuccess(com.sun.jersey.api.client.ClientResponse cr)

initialize

public static void initialize(com.sun.jersey.api.client.Client client)