org.glassfish.admin.rest.resources

Class TemplateRestResource

java.lang.Object

org.glassfish.admin.rest.resources.AbstractResource

org.glassfish.admin.rest.resources.TemplateRestResource

All Implemented Interfaces:

OptionsCapable

Direct Known Subclasses:

GlassFishDomainResource, PropertiesBagResource.PropertyResource

@Produces(value={"text/html","application/json","application/xml","application/x-www-form-urlencoded"})
 @Consumes(value={"application/json","application/xml","application/x-www-form-urlencoded"})
public class TemplateRestResource
extends AbstractResource
implements OptionsCapable

Author:

Ludovic Champenois ludo@java.net, Rajeshwar Patil

Field Summary

Fields

Modifier and Type	Field and Description
protected String	childID
protected org.jvnet.hk2.config.ConfigModel	childModel
protected org.jvnet.hk2.config.Dom	entity
static LocalStringManagerImpl	localStrings
protected org.jvnet.hk2.config.Dom	parent
protected String	tagName

Fields inherited from class org.glassfish.admin.rest.resources.AbstractResource

locatorBridge, logger, requestHeaders, securityContext, serviceLocator, subjectRef, uriInfo

Constructor Summary

Constructors

Constructor and Description
TemplateRestResource() Creates a new instance of xxxResource

Method Summary

Modifier and Type	Method and Description
protected ActionReportResult	buildActionReportResult(boolean showEntityValues)
static HashMap<String,String>	createDataBasedOnForm(org.glassfish.jersey.media.multipart.FormDataMultiPart formData) allows for remote files to be put in a tmp area and we pass the local location of this file to the corresponding command instead of the content of the file * Yu need to add enctype="multipart/form-data" in the form for ex: then any param of type="file" will be uploaded, stored locally and the param will use the local location on the server side (ie.
javax.ws.rs.core.Response	createOrUpdateEntity(HashMap<String,String> data)
javax.ws.rs.core.Response	createOrUpdateEntityLegacyFormat(HashMap<String,String> data)
javax.ws.rs.core.Response	delete(HashMap<String,String> data)
protected RestActionReporter	doCreateOrUpdate(HashMap<String,String> data) This method performs the creation or updating of an entity, regardless of the request's mime type.
protected ActionReport.ExitCode	doDelete(HashMap<String,String> data)
protected String[][]	getCommandResourcesPaths()
protected String	getDeleteCommand()
org.jvnet.hk2.config.Dom	getEntity()
Map<String,String>	getEntity(int expandLevel)
ActionReportResult	getEntityLegacyFormat(int expandLevel)
javax.ws.rs.core.UriInfo	getUriInfo()
protected javax.ws.rs.core.Response	handleError(javax.ws.rs.core.Response.Status error, String message)
RestResourceMetadata	options()
ActionReportResult	optionsLegacyFormat()
Object	post(org.glassfish.jersey.media.multipart.FormDataMultiPart formData)
Object	postLegacyFormat(org.glassfish.jersey.media.multipart.FormDataMultiPart formData) allows for remote files to be put in a tmp area and we pass the local location of this file to the corresponding command instead of the content of the file * Yu need to add enctype="multipart/form-data" in the form for ex: then any param of type="file" will be uploaded, stored locally and the param will use the local location on the server side (ie.
protected void	removeAttributesToBeSkipped(Map<String,String> data)
void	setBeanByKey(List<org.jvnet.hk2.config.Dom> parentList, String id, String tag)
void	setEntity(org.jvnet.hk2.config.Dom p)
void	setParentAndTagName(org.jvnet.hk2.config.Dom parent, String tagName)
void	setUriInfo(javax.ws.rs.core.UriInfo uriInfo)
protected void	throwError(javax.ws.rs.core.Response.Status error, String message)

Methods inherited from class org.glassfish.admin.rest.resources.AbstractResource

getAuthenticatedUser, getSubject

Methods inherited from class java.lang.Object

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

Field Detail

entity

protected org.jvnet.hk2.config.Dom entity

parent

protected org.jvnet.hk2.config.Dom parent

tagName

protected String tagName

childModel

protected org.jvnet.hk2.config.ConfigModel childModel

childID

protected String childID

localStrings

public static final LocalStringManagerImpl localStrings

Constructor Detail

TemplateRestResource

public TemplateRestResource()

Creates a new instance of xxxResource

Method Detail

getEntityLegacyFormat

@GET
public ActionReportResult getEntityLegacyFormat(@QueryParam(value="expandLevel") @DefaultValue(value="1")
                                                     int expandLevel)

getEntity

@GET
 @Produces(value="application/vnd.oracle.glassfish+json")
public Map<String,String> getEntity(@QueryParam(value="expandLevel") @DefaultValue(value="1")
                                                                                                   int expandLevel)

createOrUpdateEntityLegacyFormat

@POST
public javax.ws.rs.core.Response createOrUpdateEntityLegacyFormat(HashMap<String,String> data)

createOrUpdateEntity

@POST
 @Produces(value="application/vnd.oracle.glassfish+json")
public javax.ws.rs.core.Response createOrUpdateEntity(HashMap<String,String> data)

postLegacyFormat

@POST
 @Consumes(value="multipart/form-data")
public Object postLegacyFormat(org.glassfish.jersey.media.multipart.FormDataMultiPart formData)

allows for remote files to be put in a tmp area and we pass the local location of this file to the corresponding command instead of the content of the file * Yu need to add enctype="multipart/form-data" in the form for ex: then any param of type="file" will be uploaded, stored locally and the param will use the local location on the server side (ie. just the path)

post

@POST
 @Consumes(value="multipart/form-data")
 @Produces(value="application/vnd.oracle.glassfish+json")
public Object post(org.glassfish.jersey.media.multipart.FormDataMultiPart formData)

delete

@DELETE
public javax.ws.rs.core.Response delete(HashMap<String,String> data)

optionsLegacyFormat

@OPTIONS
 @Produces(value="application/json")
public ActionReportResult optionsLegacyFormat()

options

@OPTIONS
 @Produces(value="application/vnd.oracle.glassfish+json")
public RestResourceMetadata options()

doCreateOrUpdate

protected RestActionReporter doCreateOrUpdate(HashMap<String,String> data)

This method performs the creation or updating of an entity, regardless of the request's mime type. If an error occurs, a WebApplicationException is thrown, so if the method returns, the create/update was successful.

Parameters:

data -

Returns:

doDelete

protected ActionReport.ExitCode doDelete(HashMap<String,String> data)

getUriInfo

public javax.ws.rs.core.UriInfo getUriInfo()

Specified by:

getUriInfo in interface OptionsCapable

setUriInfo

public void setUriInfo(javax.ws.rs.core.UriInfo uriInfo)

Specified by:

setUriInfo in interface OptionsCapable

setEntity

public void setEntity(org.jvnet.hk2.config.Dom p)

getEntity

public org.jvnet.hk2.config.Dom getEntity()

setParentAndTagName

public void setParentAndTagName(org.jvnet.hk2.config.Dom parent,
                                String tagName)

createDataBasedOnForm

public static HashMap<String,String> createDataBasedOnForm(org.glassfish.jersey.media.multipart.FormDataMultiPart formData)

allows for remote files to be put in a tmp area and we pass the local location of this file to the corresponding command instead of the content of the file * Yu need to add enctype="multipart/form-data" in the form for ex: then any param of type="file" will be uploaded, stored locally and the param will use the local location on the server side (ie. just the path)

setBeanByKey

public void setBeanByKey(List<org.jvnet.hk2.config.Dom> parentList,
                         String id,
                         String tag)

buildActionReportResult

protected ActionReportResult buildActionReportResult(boolean showEntityValues)

removeAttributesToBeSkipped

protected void removeAttributesToBeSkipped(Map<String,String> data)

getCommandResourcesPaths

protected String[][] getCommandResourcesPaths()

getDeleteCommand

protected String getDeleteCommand()

throwError

protected void throwError(javax.ws.rs.core.Response.Status error,
                          String message)
                   throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

handleError

protected javax.ws.rs.core.Response handleError(javax.ws.rs.core.Response.Status error,
                                                String message)
                                         throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException