com.tsgrp.opencontent.wizard.admin

Class RESTWizard2Admin

java.lang.Object

com.tsgrp.opencontent.rest.RESTService

com.tsgrp.opencontent.wizard.admin.RESTWizard2Admin

@Controller
public class RESTWizard2Admin
extends RESTService

Rest services for the Active Wizard 5.x (and higher) administration components.

Field Summary

Fields inherited from class com.tsgrp.opencontent.rest.RESTService

CHUNKSIZE, HEADER_ACCEPT_LANGUAGE, HEADER_ACCEPT_RANGES, HEADER_CACHE_CONTROL, HEADER_CONTENT_DISPOSITION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_RANGE, HEADER_CONTENT_TYPE, HEADER_ETAG, HEADER_IF_MODIFIED_SINCE, HEADER_LAST_MODIFIED, HEADER_LOCATION, HEADER_RANGE, HEADER_USER_AGENT, MULTIPART_BYTERANGES_BOUNDRY, MULTIPART_BYTERANGES_BOUNDRY_END, MULTIPART_BYTERANGES_BOUNDRY_SEP, MULTIPART_BYTERANGES_HEADER

Constructor Summary

Constructors

Constructor and Description
RESTWizard2Admin()

Method Summary

Modifier and Type	Method and Description
void	activatePageSet(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String versionLabel, java.lang.String cookieTicket)
boolean	checkinPageSetDefinition(java.lang.String paramTicket, java.lang.String id, java.lang.String pageSetName, java.lang.String cookieTicket, byte[] psdBytes) Deprecated.
boolean	checkinQuery(java.lang.String paramTicket, java.lang.String id, java.lang.String cookieTicket, byte[] queryBytes) Deprecated.
PageSetDefinition	copyPageSetDefinition(java.lang.String paramTicket, PageSetDefinition psDefToCopy, java.lang.String newPsDefName, java.lang.String cookieTicket)
java.lang.String	createAutoNumber(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String startNumber, java.lang.String prefix, java.lang.String suffix, java.lang.String cookieTicket)
Page	createPage(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String pageId, java.lang.String pageTitle, java.lang.String pageDescription, java.lang.String category, byte[] pageBytes, java.lang.String cookieTicket)
PageSetDefinition	createPageSetDefinition(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String outputType, java.lang.String instanceType, boolean wfActive, byte[] psdBytes, java.lang.String cookieTicket)
WizardQuery	createQuery(java.lang.String paramTicket, java.lang.String queryName, byte[] queryBytes, java.lang.String cookieTicket)
void	deletePageSetDefinition(java.lang.String paramTicket, java.lang.String pageSetName, boolean keepPublishedVersion, java.lang.String cookieTicket)
java.lang.String[]	getAllQueryImplNames()
java.lang.String[]	getAllQueryNames(java.lang.String paramTicket, java.lang.String cookieTicket)
java.lang.String[]	getAllSecuritySetNames(java.lang.String paramTicket, java.lang.String cookieTicket)
protected javax.activation.DataHandler	getDataHandlerFromBytes(byte[] data) Get a data handler from a byte[]
Page	getPage(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String pageId, java.lang.String cookieTicket)
Page[]	getPages(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String category, java.lang.String cookieTicket)
PageSet[]	getPageSet(java.lang.String paramTicket, java.lang.String pageSetName, boolean allVersions, java.lang.String cookieTicket)
java.lang.String[]	getPageSetCategories(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String cookieTicket)
PageSetDefinition	getPageSetDefinition(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String cookieTicket)
PageSetDefinition[]	getPageSetDefinitions(java.lang.String paramTicket, java.lang.String cookieTicket)
Page[]	getPagesInSetById(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String pageIds, java.lang.String cookieTicket)
java.lang.String[]	getPSISecuritySetNames(java.lang.String paramTicket, java.lang.String cookieTicket)
WizardQuery	getQuery(java.lang.String paramTicket, java.lang.String queryName, java.lang.String cookieTicket)
PageSet	publishPageSet(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String comment, boolean majorVersion, java.lang.String cookieTicket)
Page	updatePage(java.lang.String paramTicket, java.lang.String pageSetName, java.lang.String pageId, java.lang.String pageTitle, java.lang.String pageDescription, java.lang.String category, byte[] pageBytes, java.lang.String cookieTicket)

Methods inherited from class com.tsgrp.opencontent.rest.RESTService

contentNotProcessed, contentNotReady, genericException, notAuth, notFoundException, notSupported, objectLocked, ocConflict, ocConflict, ocForbidden, ocRuntimeException, resolveTicket

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTWizard2Admin

public RESTWizard2Admin()

Method Detail

getPageSetDefinitions

@RequestMapping(value="/aw-admin/getPageSetDefinitions",
                method=GET)
 @ResponseBody
public PageSetDefinition[] getPageSetDefinitions(@RequestParam(value="ticket",required=false)
                                                                                                                                                        java.lang.String paramTicket,
                                                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                                                        java.lang.String cookieTicket)

getPageSetDefinition

@RequestMapping(value="/aw-admin/getPageSetDefinition",
                method=GET)
 @ResponseBody
public PageSetDefinition getPageSetDefinition(@RequestParam(value="ticket",required=false)
                                                                                                                                                    java.lang.String paramTicket,
                                                                                                                                                    @RequestParam(value="pageSetName",required=false)
                                                                                                                                                    java.lang.String pageSetName,
                                                                                                                                                    @CookieValue(value="ticket",required=false)
                                                                                                                                                    java.lang.String cookieTicket)

createPageSetDefinition

@RequestMapping(value="/aw-admin/createPageSetDefinition",
                method=POST)
 @ResponseBody
public PageSetDefinition createPageSetDefinition(@RequestParam(value="ticket",required=false)
                                                                                                                                                           java.lang.String paramTicket,
                                                                                                                                                           @RequestParam(value="pageSetName")
                                                                                                                                                           java.lang.String pageSetName,
                                                                                                                                                           @RequestParam(value="outputType")
                                                                                                                                                           java.lang.String outputType,
                                                                                                                                                           @RequestParam(value="instanceType")
                                                                                                                                                           java.lang.String instanceType,
                                                                                                                                                           @RequestParam(value="wfActive")
                                                                                                                                                           boolean wfActive,
                                                                                                                                                           @RequestBody
                                                                                                                                                           byte[] psdBytes,
                                                                                                                                                           @CookieValue(value="ticket",required=false)
                                                                                                                                                           java.lang.String cookieTicket)

copyPageSetDefinition

@RequestMapping(value="/aw-admin/copyPageSetDefinition",
                method=POST)
 @ResponseBody
public PageSetDefinition copyPageSetDefinition(@RequestParam(value="ticket",required=false)
                                                                                                                                                       java.lang.String paramTicket,
                                                                                                                                                       @RequestBody
                                                                                                                                                       PageSetDefinition psDefToCopy,
                                                                                                                                                       @RequestParam(value="newPsDefName")
                                                                                                                                                       java.lang.String newPsDefName,
                                                                                                                                                       @CookieValue(value="ticket",required=false)
                                                                                                                                                       java.lang.String cookieTicket)

deletePageSetDefinition

@RequestMapping(value="/aw-admin/deletePageSetDefinition",
                method=DELETE)
 @ResponseBody
public void deletePageSetDefinition(@RequestParam(value="ticket",required=false)
                                                                                                                                                java.lang.String paramTicket,
                                                                                                                                                @RequestParam(value="pageSetName",required=true)
                                                                                                                                                java.lang.String pageSetName,
                                                                                                                                                @RequestParam(value="keepPublishedVersion",required=false)
                                                                                                                                                boolean keepPublishedVersion,
                                                                                                                                                @CookieValue(value="ticket",required=false)
                                                                                                                                                java.lang.String cookieTicket)
                                                                                                                                         throws OCObjectLockedException

Throws:

OCObjectLockedException

publishPageSet

@RequestMapping(value="/aw-admin/publishPageSet",
                method=POST)
 @ResponseBody
public PageSet publishPageSet(@RequestParam(value="ticket",required=false)
                                                                                                                               java.lang.String paramTicket,
                                                                                                                               @RequestParam(value="pageSetName")
                                                                                                                               java.lang.String pageSetName,
                                                                                                                               @RequestParam(value="comment")
                                                                                                                               java.lang.String comment,
                                                                                                                               @RequestParam(value="majorVersion")
                                                                                                                               boolean majorVersion,
                                                                                                                               @CookieValue(value="ticket",required=false)
                                                                                                                               java.lang.String cookieTicket)

activatePageSet

@RequestMapping(value="/aw-admin/activatePageSet",
                method=POST)
 @ResponseBody
public void activatePageSet(@RequestParam(value="ticket",required=false)
                                                                                                                              java.lang.String paramTicket,
                                                                                                                              @RequestParam(value="pageSetName")
                                                                                                                              java.lang.String pageSetName,
                                                                                                                              @RequestParam(value="versionLabel")
                                                                                                                              java.lang.String versionLabel,
                                                                                                                              @CookieValue(value="ticket",required=false)
                                                                                                                              java.lang.String cookieTicket)

getPageSet

@RequestMapping(value="/aw-admin/getPageSet",
                method=GET)
 @ResponseBody
public PageSet[] getPageSet(@RequestParam(value="ticket",required=false)
                                                                                                                        java.lang.String paramTicket,
                                                                                                                        @RequestParam(value="pageSetName")
                                                                                                                        java.lang.String pageSetName,
                                                                                                                        @RequestParam(value="allVersions")
                                                                                                                        boolean allVersions,
                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                        java.lang.String cookieTicket)

getPages

@RequestMapping(value="/aw-admin/getPages",
                method=GET)
 @ResponseBody
public Page[] getPages(@RequestParam(value="ticket",required=false)
                                                                                                                 java.lang.String paramTicket,
                                                                                                                 @RequestParam(value="pageSetName")
                                                                                                                 java.lang.String pageSetName,
                                                                                                                 @RequestParam(value="category",required=false)
                                                                                                                 java.lang.String category,
                                                                                                                 @CookieValue(value="ticket",required=false)
                                                                                                                 java.lang.String cookieTicket)

See Also:

IWizard2Admin#getPages(String, String)

getPage

@RequestMapping(value="/aw-admin/getPage",
                method=GET)
 @ResponseBody
public Page getPage(@RequestParam(value="ticket",required=false)
                                                                                                             java.lang.String paramTicket,
                                                                                                             @RequestParam(value="pageSetName")
                                                                                                             java.lang.String pageSetName,
                                                                                                             @RequestParam(value="pageId")
                                                                                                             java.lang.String pageId,
                                                                                                             @CookieValue(value="ticket",required=false)
                                                                                                             java.lang.String cookieTicket)

See Also:

IWizard2Admin.getPage(String, String, String)

createPage

@RequestMapping(value="/aw-admin/createPage",
                method=POST)
 @ResponseBody
public Page createPage(@RequestParam(value="ticket",required=false)
                                                                                                                    java.lang.String paramTicket,
                                                                                                                    @RequestParam(value="pageSetName")
                                                                                                                    java.lang.String pageSetName,
                                                                                                                    @RequestParam(value="pageId")
                                                                                                                    java.lang.String pageId,
                                                                                                                    @RequestParam(value="pageTitle")
                                                                                                                    java.lang.String pageTitle,
                                                                                                                    @RequestParam(value="pageDescription")
                                                                                                                    java.lang.String pageDescription,
                                                                                                                    @RequestParam(value="category")
                                                                                                                    java.lang.String category,
                                                                                                                    @RequestBody
                                                                                                                    byte[] pageBytes,
                                                                                                                    @CookieValue(value="ticket",required=false)
                                                                                                                    java.lang.String cookieTicket)

updatePage

@RequestMapping(value="/aw-admin/updatePage",
                method=POST)
 @ResponseBody
public Page updatePage(@RequestParam(value="ticket",required=false)
                                                                                                                    java.lang.String paramTicket,
                                                                                                                    @RequestParam(value="pageSetName")
                                                                                                                    java.lang.String pageSetName,
                                                                                                                    @RequestParam(value="pageId")
                                                                                                                    java.lang.String pageId,
                                                                                                                    @RequestParam(value="pageTitle")
                                                                                                                    java.lang.String pageTitle,
                                                                                                                    @RequestParam(value="pageDescription")
                                                                                                                    java.lang.String pageDescription,
                                                                                                                    @RequestParam(value="category")
                                                                                                                    java.lang.String category,
                                                                                                                    @RequestBody
                                                                                                                    byte[] pageBytes,
                                                                                                                    @CookieValue(value="ticket",required=false)
                                                                                                                    java.lang.String cookieTicket)

createAutoNumber

@RequestMapping(value="/aw-admin/createAutoNumber",
                method=POST)
 @ResponseBody
public java.lang.String createAutoNumber(@RequestParam(value="ticket",required=false)
                                                                                                                                            java.lang.String paramTicket,
                                                                                                                                            @RequestParam(value="pageSetName")
                                                                                                                                            java.lang.String pageSetName,
                                                                                                                                            @RequestParam(value="startNumber")
                                                                                                                                            java.lang.String startNumber,
                                                                                                                                            @RequestParam(value="prefix")
                                                                                                                                            java.lang.String prefix,
                                                                                                                                            @RequestParam(value="suffix")
                                                                                                                                            java.lang.String suffix,
                                                                                                                                            @CookieValue(value="ticket",required=false)
                                                                                                                                            java.lang.String cookieTicket)

getAllQueryNames

@RequestMapping(value="/aw-admin/getAllQueryNames",
                method=GET)
 @ResponseBody
public java.lang.String[] getAllQueryNames(@RequestParam(value="ticket",required=false)
                                                                                                                                             java.lang.String paramTicket,
                                                                                                                                             @CookieValue(value="ticket",required=false)
                                                                                                                                             java.lang.String cookieTicket)

getAllQueryImplNames

@RequestMapping(value="/aw-admin/getAllQueryImplNames",
                method=GET)
 @ResponseBody
public java.lang.String[] getAllQueryImplNames()

createQuery

@RequestMapping(value="/aw-admin/createQuery",
                method=POST)
 @ResponseBody
public WizardQuery createQuery(@RequestParam(value="ticket",required=false)
                                                                                                                             java.lang.String paramTicket,
                                                                                                                             @RequestParam(value="queryName")
                                                                                                                             java.lang.String queryName,
                                                                                                                             @RequestBody
                                                                                                                             byte[] queryBytes,
                                                                                                                             @CookieValue(value="ticket",required=false)
                                                                                                                             java.lang.String cookieTicket)

getQuery

@RequestMapping(value="/aw-admin/getQuery",
                method=GET)
 @ResponseBody
public WizardQuery getQuery(@RequestParam(value="ticket",required=false)
                                                                                                                      java.lang.String paramTicket,
                                                                                                                      @RequestParam(value="queryName")
                                                                                                                      java.lang.String queryName,
                                                                                                                      @CookieValue(value="ticket",required=false)
                                                                                                                      java.lang.String cookieTicket)

See Also:

IWizard2Admin.getQuery(String, String)

getPSISecuritySetNames

@RequestMapping(value="/aw-admin/getPSISecuritySetNames",
                method=GET)
 @ResponseBody
public java.lang.String[] getPSISecuritySetNames(@RequestParam(value="ticket",required=false)
                                                                                                                                                         java.lang.String paramTicket,
                                                                                                                                                         @CookieValue(value="ticket",required=false)
                                                                                                                                                         java.lang.String cookieTicket)

See Also:

IWizard2Admin.getPSISecuritySetNames(String)

getPageSetCategories

@RequestMapping(value="/aw-admin/getPageSetCategories",
                method=GET)
 @ResponseBody
public java.lang.String[] getPageSetCategories(@RequestParam(value="ticket",required=false)
                                                                                                                                                     java.lang.String paramTicket,
                                                                                                                                                     @RequestParam(value="pageSetName")
                                                                                                                                                     java.lang.String pageSetName,
                                                                                                                                                     @CookieValue(value="ticket",required=false)
                                                                                                                                                     java.lang.String cookieTicket)

getPagesInSetById

@RequestMapping(value="/aw-admin/getPagesInSetById",
                method=GET)
 @ResponseBody
public Page[] getPagesInSetById(@RequestParam(value="ticket",required=false)
                                                                                                                                   java.lang.String paramTicket,
                                                                                                                                   @RequestParam(value="pageSetName")
                                                                                                                                   java.lang.String pageSetName,
                                                                                                                                   @RequestParam(value="pageIds[]")
                                                                                                                                   java.lang.String pageIds,
                                                                                                                                   @CookieValue(value="ticket",required=false)
                                                                                                                                   java.lang.String cookieTicket)

getAllSecuritySetNames

@RequestMapping(value="/aw-admin/getAllSecuritySetNames",
                method=GET)
 @ResponseBody
public java.lang.String[] getAllSecuritySetNames(@RequestParam(value="ticket",required=false)
                                                                                                                                                         java.lang.String paramTicket,
                                                                                                                                                         @CookieValue(value="ticket",required=false)
                                                                                                                                                         java.lang.String cookieTicket)

See Also:

IWizard2Admin.getAllSecuritySetNames(String)

getDataHandlerFromBytes

protected javax.activation.DataHandler getDataHandlerFromBytes(byte[] data)

Get a data handler from a byte[]

Parameters:

data -

Returns:

checkinPageSetDefinition

@Deprecated
 @RequestMapping(value="/aw-admin/checkinPSD",
                method=POST)
 @ResponseBody
public boolean checkinPageSetDefinition(@RequestParam(value="ticket",required=false)
                                                                                                                                                   java.lang.String paramTicket,
                                                                                                                                                   @RequestParam(value="id",required=false)
                                                                                                                                                   java.lang.String id,
                                                                                                                                                   @RequestParam(value="pageSetName",required=false)
                                                                                                                                                   java.lang.String pageSetName,
                                                                                                                                                   @CookieValue(value="ticket",required=false)
                                                                                                                                                   java.lang.String cookieTicket,
                                                                                                                                                   @RequestBody
                                                                                                                                                   byte[] psdBytes)

Deprecated.

checkinQuery

@Deprecated
 @RequestMapping(value="/aw-admin/checkinQuery",
                method=POST)
 @ResponseBody
public boolean checkinQuery(@RequestParam(value="ticket",required=false)
                                                                                                                                         java.lang.String paramTicket,
                                                                                                                                         @RequestParam(value="id",required=true)
                                                                                                                                         java.lang.String id,
                                                                                                                                         @CookieValue(value="ticket",required=false)
                                                                                                                                         java.lang.String cookieTicket,
                                                                                                                                         @RequestBody
                                                                                                                                         byte[] queryBytes)

Deprecated.