com.jalios.jcms.rest

Class RestUtil

java.lang.Object

com.jalios.jcms.rest.RestUtil

public class RestUtil
extends java.lang.Object

Provides utility static methods for both client and server side in REST communication.

Since:

JCMS-6.0

Author:

dissert

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CSRF_HEADER_NAME
static java.lang.String	XML_UTF_8_STANDARD_BOM

Constructor Summary

Constructors

Constructor and Description
RestUtil()

Method Summary

Modifier and Type	Method and Description
static void	displayResponse(org.restlet.data.Response response) Dev method to print in syso the content of a response
static java.lang.String	formatMsgToXml(javax.servlet.http.HttpServletRequest request) Get the info, warning and error messages in the request and in the session and returns a xml with all this informations.
static java.lang.String	formatMsgToXml(javax.servlet.http.HttpServletRequest request, boolean displayInfo, boolean displayWarning, boolean displayError) Get the info, warning and error messages in the request and in the session and returns a xml with all this informations.
static java.lang.String	formatXmlEntityError(java.lang.String code, java.lang.String message) Print an message in the following format (without indentation) : code message
static java.lang.String	getExtension(org.restlet.data.MediaType mediaType) Gives an possible extension from a mime-type.
static org.restlet.data.Form	getForm(org.restlet.resource.Representation entity) Gives a form representation of the parameters in the entity-body.
static org.restlet.data.Form	getForm(java.lang.String queryString) Gives a form representation of the parameters in the queryString.
static org.restlet.data.Reference	getReferenceFromUriSuffix(java.lang.String uriSuffix, javax.servlet.http.HttpServletRequest j2eeRequest) Gives the complete URL from an external point of vue, from an uri with no context-path and "rest" prefix
static boolean	isRest(javax.servlet.http.HttpServletRequest request)
static void	sendApplicationError(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get the messages in request or in session and put it formatted in the entity body of the response and set CLIENT_ERROR_BAD_REQUEST (400) HTTP error code.
static void	sendDetailedError(javax.servlet.http.HttpServletResponse response, int errorCode, java.lang.String applicationErrorCode, java.lang.String applicationErrorMessage)
static void	sendError(javax.servlet.http.HttpServletResponse response, int errorCode)
static void	sendError(javax.servlet.http.HttpServletResponse response, int errorCode, java.lang.String message)
static void	sendError(javax.servlet.http.HttpServletResponse response, org.restlet.data.Status error)

Methods inherited from class java.lang.Object

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

Field Detail

XML_UTF_8_STANDARD_BOM

public static final java.lang.String XML_UTF_8_STANDARD_BOM

See Also:

Constant Field Values

CSRF_HEADER_NAME

public static final java.lang.String CSRF_HEADER_NAME

See Also:

Constant Field Values

Constructor Detail

RestUtil

public RestUtil()

Method Detail

isRest

public static final boolean isRest(javax.servlet.http.HttpServletRequest request)

sendError

public static void sendError(javax.servlet.http.HttpServletResponse response,
                             org.restlet.data.Status error)
                      throws java.io.IOException

Throws:

java.io.IOException

sendError

public static void sendError(javax.servlet.http.HttpServletResponse response,
                             int errorCode,
                             java.lang.String message)
                      throws java.io.IOException

Throws:

java.io.IOException

sendError

public static void sendError(javax.servlet.http.HttpServletResponse response,
                             int errorCode)
                      throws java.io.IOException

Throws:

java.io.IOException

sendDetailedError

public static void sendDetailedError(javax.servlet.http.HttpServletResponse response,
                                     int errorCode,
                                     java.lang.String applicationErrorCode,
                                     java.lang.String applicationErrorMessage)
                              throws java.io.IOException

Throws:

java.io.IOException

formatXmlEntityError

public static java.lang.String formatXmlEntityError(java.lang.String code,
                                                    java.lang.String message)

Print an message in the following format (without indentation) : code message

Parameters:

code -

message -

Returns:

the formatted XML String

displayResponse

public static void displayResponse(org.restlet.data.Response response)
                            throws java.io.IOException

Dev method to print in syso the content of a response

Parameters:

response - a Restlet response

Throws:

java.io.IOException - if the text content of the entity body can't be retrieved

formatMsgToXml

public static java.lang.String formatMsgToXml(javax.servlet.http.HttpServletRequest request)

Get the info, warning and error messages in the request and in the session and returns a xml with all this informations. The form of the XML is as follow : message in the lang of the current logged member message in the lang of the current logged member message in the lang of the current logged member message in the lang of the current logged member message in the lang of the current logged member message in the lang of the current logged member If an XML element would be empty, it is not set.

Parameters:

request - the current request

Returns:

the formatted xml message.

formatMsgToXml

public static java.lang.String formatMsgToXml(javax.servlet.http.HttpServletRequest request,
                                              boolean displayInfo,
                                              boolean displayWarning,
                                              boolean displayError)

Get the info, warning and error messages in the request and in the session and returns a xml with all this informations. But info, warning or error level messages may be skipped.

Parameters:

request - the current request

displayInfo - if false, info message is skipped

displayWarning - if false, warning message is skipped

displayError - if false, error message is skipped

Returns:

the formatted message

sendApplicationError

public static void sendApplicationError(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws java.io.IOException

Get the messages in request or in session and put it formatted in the entity body of the response and set CLIENT_ERROR_BAD_REQUEST (400) HTTP error code.

Parameters:

request - the current request

response - the current response

Throws:

java.io.IOException - if the printer is innaccessible

getExtension

public static java.lang.String getExtension(org.restlet.data.MediaType mediaType)

Gives an possible extension from a mime-type. If present in "file-document.ext" properties

Parameters:

mediaType -

Returns:

possible extensions

Since:

JCMS-6.1

getReferenceFromUriSuffix

public static org.restlet.data.Reference getReferenceFromUriSuffix(java.lang.String uriSuffix,
                                                                   javax.servlet.http.HttpServletRequest j2eeRequest)

Gives the complete URL from an external point of vue, from an uri with no context-path and "rest" prefix

Parameters:

uriSuffix - the uriSuffix with no context-path and no "rest" prefix

j2eeRequest - The current J2EE request

Returns:

the complete URL, with the base URL

Since:

JCMS-6.1

getForm

public static org.restlet.data.Form getForm(java.lang.String queryString)

Gives a form representation of the parameters in the queryString. If parameter have a transformation specific format, they are transformed into the good value. Example :

• If a value of a parameter is in the form "date(long,123456789)", it is transformed into a localized format date.

Parameters:

queryString - the query string

Returns:

the form

Since:

jcms-6.1.3

getForm

public static org.restlet.data.Form getForm(org.restlet.resource.Representation entity)

Gives a form representation of the parameters in the entity-body. If parameter have a transformation specific format, they are transformed into the good value. Example :

• If a value of a parameter is in the form "date(long,123456789)", or "date(w3c,1999-01-01T14:07:00+01:00)" it is transformed into a localized format date.

Parameters:

entity - A representation

Returns:

the form

Since:

jcms-6.1.3