Package org.opencms.ugc

Class CmsUgcEditService

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

com.google.gwt.user.server.rpc.jakarta.AbstractRemoteServiceServlet

com.google.gwt.user.server.rpc.jakarta.RemoteServiceServlet

org.opencms.gwt.CmsGwtService

org.opencms.ugc.CmsUgcEditService

All Implemented Interfaces:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, I_CmsUgcEditService

public class CmsUgcEditService
extends CmsGwtService
implements I_CmsUgcEditService

The form editing service.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.google.gwt.user.server.rpc.jakarta.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
CmsUgcEditService()

Method Summary

Modifier and Type	Method	Description
void	checkPermissions(CmsObject cms)	Checks the permissions of the current user to match the required security level.
void	destroySession(CmsUUID sessionId)	Destroys the given session.
void	error(Throwable t)	Logs and re-throws the given exception for RPC responses.
CmsUgcContent	getContent(CmsUUID sessionId)	Loads the form content for an existing session.
String	getLink(String path)	Gets the link corresponding to a given site path.
protected void	handleUpload(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handles all multipart requests.
Map<String,String>	saveContent(CmsUUID sessionId, Map<String,String> contentValues)	Saves the given content values to the edited content.
protected void	service(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
Map<String,String>	uploadFiles(CmsUUID sessionId, Set<String> fieldNames, String formDataId)	Uploads multiple files.
Map<String,String>	validateContent(CmsUUID sessionId, Map<String,String> contentValues)	Validates the new content values for a content loaded in the given session.

Methods inherited from class org.opencms.gwt.CmsGwtService

clearThreadStorage, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureLock, ensureSession, getCmsObject, getPropertiesByName, getRequest, getResponse, isBroadcastCall, log, log, logError, service, setBroadcastPoll, setCms, setContext, setRequest, setResponse, tryUnlock

Methods inherited from class com.google.gwt.user.server.rpc.jakarta.RemoteServiceServlet

checkPermutationStrongName, getCodeServerPolicyUrl, getRequestModuleBasePath, getSerializationPolicy, init, loadPolicyFromCodeServer, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processCall, processPost, shouldCompressResponse

Methods inherited from class com.google.gwt.user.server.rpc.jakarta.AbstractRemoteServiceServlet

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init

Methods inherited from class java.lang.Object

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

Constructor Details

CmsUgcEditService

public CmsUgcEditService()

Method Details

checkPermissions

public void checkPermissions(CmsObject cms)

Description copied from class: CmsGwtService

Checks the permissions of the current user to match the required security level.

Note that the current request and response are not available yet.

Override if needed.

Overrides:

checkPermissions in class CmsGwtService

Parameters:

cms - the current cms object

See Also:

• CmsGwtService.checkPermissions(org.opencms.file.CmsObject)

destroySession

public void destroySession(CmsUUID sessionId)
                    throws CmsUgcException

Description copied from interface: I_CmsUgcEditService

Destroys the given session.

Specified by:

destroySession in interface I_CmsUgcEditService

Parameters:

sessionId - the id of the session to destroy

Throws:

CmsUgcException

See Also:

• I_CmsUgcEditService.destroySession(org.opencms.util.CmsUUID)

error

public void error(Throwable t)
           throws CmsUgcException

Description copied from class: CmsGwtService

Logs and re-throws the given exception for RPC responses.

Overrides:

error in class CmsGwtService

Parameters:

t - the exception

Throws:

CmsUgcException

See Also:

• CmsGwtService.error(java.lang.Throwable)

getContent

public CmsUgcContent getContent(CmsUUID sessionId)
                         throws CmsUgcException

Description copied from interface: I_CmsUgcEditService

Loads the form content for an existing session.

Specified by:

getContent in interface I_CmsUgcEditService

Parameters:

sessionId - the id of the existing session

Returns:

the form content information

Throws:

CmsUgcException

See Also:

• I_CmsUgcEditService.getContent(org.opencms.util.CmsUUID)

getLink

public String getLink(String path)

Description copied from interface: I_CmsUgcEditService

Gets the link corresponding to a given site path.

Specified by:

getLink in interface I_CmsUgcEditService

Parameters:

path - the site path

Returns:

the link for the path

See Also:

• I_CmsUgcEditService.getLink(java.lang.String)

saveContent

public Map<String,String> saveContent(CmsUUID sessionId,
 Map<String,String> contentValues)
                               throws CmsUgcException

Description copied from interface: I_CmsUgcEditService

Saves the given content values to the edited content.

Specified by:

saveContent in interface I_CmsUgcEditService

Parameters:

sessionId - the session id

contentValues - the content values

Returns:

the validation errors, if there are any

Throws:

CmsUgcException

See Also:

• I_CmsUgcEditService.saveContent(org.opencms.util.CmsUUID, java.util.Map)

uploadFiles

public Map<String,String> uploadFiles(CmsUUID sessionId,
 Set<String> fieldNames,
 String formDataId)
                               throws CmsRpcException

Description copied from interface: I_CmsUgcEditService

Uploads multiple files.

Specified by:

uploadFiles in interface I_CmsUgcEditService

Parameters:

sessionId - the session id

fieldNames - the set of field names of the form fields containing the uploaded files

formDataId - the form data id of the form submit in which the form fields were posted

Returns:

the map from field names to the VFS paths of uploaded files

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsUgcEditService.uploadFiles(org.opencms.util.CmsUUID, java.util.Set, java.lang.String)

validateContent

public Map<String,String> validateContent(CmsUUID sessionId,
 Map<String,String> contentValues)
                                   throws CmsUgcException

Description copied from interface: I_CmsUgcEditService

Validates the new content values for a content loaded in the given session.

Specified by:

validateContent in interface I_CmsUgcEditService

Parameters:

sessionId - the id of the session containing the content

contentValues - the values to validate

Returns:

the map of validation results

Throws:

CmsUgcException - if something goes wrong

See Also:

• I_CmsUgcEditService.validateContent(org.opencms.util.CmsUUID, java.util.Map)

handleUpload

protected void handleUpload(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Handles all multipart requests.

Parameters:

request - the request

response - the response

service

protected void service(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                throws jakarta.servlet.ServletException,
IOException

Overrides:

service in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

See Also:

• HttpServlet.service(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)