public class RqlContentApiClient extends RqlApiClient
The client needs to be initialized with a SecureApiClientConfiguration
object.
For example to create a client with a ticket authentication the following code can be used:
SecureApiClientConfiguration configuration = new SecureApiClientConfiguration(); configuration.setSite("mysite.com"); RqlContentApiClient client = new RqlContentApiClient(configuration); client.authenticate("user_name", "password");
To use digital signatures:
SecureApiClientConfiguration configuration = new SecureApiClientConfiguration(); configuration.setSite("mysite.com"); configuration.setUserName("user_name"); configuration.setSigningKeyPair(keyPair); RqlContentApiClient client = new RqlContentApiClient(configuration);
Constructor and Description |
---|
RqlContentApiClient(SecureApiClientConfiguration configuration)
Constructs a new
RqlContentApiClient and initializes
it with the SecureApiClientConfiguration object. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
build(java.lang.String name)
Builds an individual workbook and returns the task id.
|
java.lang.String |
buildAll()
Builds all workbooks on the home wiki.
|
java.lang.String |
buildAll(java.lang.Boolean force)
Builds all workbooks on the home wiki with the option to control the force parameter.
|
void |
deleteDictionary(java.lang.String fileName)
Deletes the dictionary file with the specified name.
|
void |
deleteMedia(java.lang.String storeId)
Deletes a media file.
|
AppInfo |
getApp(java.lang.String appName)
Represents the view of an app.
|
java.lang.String |
getAppMap()
Gets a map of the relationships between all apps.
|
java.io.InputStream |
getDictionary(java.lang.String fileName)
Downloads a published dictionary file.
|
java.io.InputStream |
getMedia(java.lang.String storeId)
Gets a media file.
|
java.lang.String |
getPBLPage(java.lang.String pageName)
Gets the PBL page content
|
PBLPageInfo |
getPBLPageInfo(java.lang.String pageName)
Gets the PBL page info about the specified page.
|
PBLPageInfo |
getPBLPageInfo(java.lang.String pageName,
java.lang.Boolean omitVersionId)
Gets the PBL page info about the specified page.
|
java.util.List<PBLPageInfo> |
getPBLPages(java.lang.String appName,
java.lang.Boolean isWorkbook)
Returns a list of PBL page info for the pages associated with the specified app or workbook.
|
java.lang.String |
getPBLPageVersion(java.lang.String pageName,
java.lang.String versionId)
Gets a specific version of a the PBL page.
|
TaskInfo |
getTask(java.lang.String storeId)
Gets the status of the
build(String) task. |
ThemeInfo |
getTheme(java.lang.String storeId)
Gets the site theme.
|
java.lang.String |
getWorkbook(java.lang.String workbookName)
Gets the raw xml of an app.
|
java.util.List<java.lang.String> |
listApps()
Lists the apps.
|
java.util.List<java.lang.String> |
listDictionaries()
Lists published dictionary file names for the site.
|
java.util.List<MediaInfo> |
listMedia(java.lang.String name,
java.lang.String category,
java.lang.String storeId)
Lists the media files.
|
java.util.List<PBLPagePropertiesInfo> |
listPBLPages(int pageIndex,
int pageSize)
Lists PBL pages.
|
java.util.List<PBLPagePropertiesInfo> |
listPBLPages(int pageIndex,
int pageSize,
java.lang.Boolean omitVersionIds,
java.lang.Boolean includePblMarkup)
Lists PBL pages and their properties including markup and workflows if desired
|
java.util.List<PBLPageVersionInfo> |
listPBLPageVersions(java.lang.String pageName)
Lists the versions of the PBL page.
|
java.util.ArrayList<ThemeInfo> |
listThemes(java.lang.String filter,
int pageIndex,
int pageSize)
Lists site themes.
|
java.lang.String |
putMedia(java.lang.String storeId,
java.lang.String name,
java.lang.String category,
java.lang.String filePath)
Creates or updates a media file.
|
java.lang.String |
putPBLPage(java.lang.String controlPblMarkupHash,
java.lang.String pageName,
java.lang.String pblMarkup)
Creates or updates a PBL page.
|
java.lang.String |
putTheme(ThemeInfo themeInfo)
Creates or updates a theme.
|
void |
uploadDictionary(java.lang.String filePath)
Uploads the xlsx dictionary file to the site.
|
getCustomSiteSettings, getSiteConfiguration, setCustomSiteSetting, setCustomSiteSettings
authenticate, getTicketExpirationDate
public RqlContentApiClient(SecureApiClientConfiguration configuration)
RqlContentApiClient
and initializes
it with the SecureApiClientConfiguration
object.configuration
- A configuration object for the API client.public java.lang.String buildAll() throws javax.xml.soap.SOAPException
A status of the task can be checked with the getTask(String)
method.
javax.xml.soap.SOAPException
public java.lang.String buildAll(java.lang.Boolean force) throws javax.xml.soap.SOAPException
force
- If set to true, will force the build step to force downloads of all wikis by the build process, instead of ones that have changed since the last build.
A status of the task can be checked with the getTask(String)
method.
javax.xml.soap.SOAPException
public java.lang.String build(java.lang.String name) throws javax.xml.soap.SOAPException
name
- The name of a workbook's root Pbl page.
A status of the task can be checked with the getTask(String)
method.
The name supplied here should be the name of the workbook, and NOT the name used in the Pbl @app tag. If there are multiple pages in a Pbl application, the name should be the name of the root page.
javax.xml.soap.SOAPException
public void deleteMedia(java.lang.String storeId) throws javax.xml.soap.SOAPException
storeId
- The store id of the media item.javax.xml.soap.SOAPException
public AppInfo getApp(java.lang.String appName) throws javax.xml.soap.SOAPException
A view is a means of presenting or collecting data to end-users in the user interface. It is defined within an app and can be of type Form or Workbook.
appName
- A name of the app.AppInfo
object containing the collection of info objects representing app entities, views and queues.javax.xml.soap.SOAPException
public java.lang.String getAppMap() throws javax.xml.soap.SOAPException
javax.xml.soap.SOAPException
public java.io.InputStream getMedia(java.lang.String storeId) throws java.io.IOException, RqlApiException
storeId
- The store id of the media item.java.io.IOException
RqlApiException
public java.lang.String getPBLPage(java.lang.String pageName) throws javax.xml.soap.SOAPException
pageName
- A name of the PBL page.javax.xml.soap.SOAPException
public java.util.List<PBLPageInfo> getPBLPages(java.lang.String appName, java.lang.Boolean isWorkbook) throws javax.xml.soap.SOAPException
appName
- isWorkbook
- javax.xml.soap.SOAPException
public PBLPageInfo getPBLPageInfo(java.lang.String pageName) throws javax.xml.soap.SOAPException
pageName
- A name of the PBL page.PBLPageInfo
object that describes the specified PBL page.javax.xml.soap.SOAPException
public PBLPageInfo getPBLPageInfo(java.lang.String pageName, java.lang.Boolean omitVersionId) throws javax.xml.soap.SOAPException
pageName
- A name of the PBL page.omitVersionId
- A flag to specify if the version Id should be omitted. This is a performance improvement if this value isn't going to be used.PBLPageInfo
object that describes the specified PBL page.javax.xml.soap.SOAPException
public java.lang.String getPBLPageVersion(java.lang.String pageName, java.lang.String versionId) throws javax.xml.soap.SOAPException
pageName
- A name of the PBL page.versionId
- The version id of the PBL page.javax.xml.soap.SOAPException
public TaskInfo getTask(java.lang.String storeId) throws javax.xml.soap.SOAPException
build(String)
task.storeId
- The task id.TaskInfo
object.
The build task is initiated by calling the build(String)
method.
javax.xml.soap.SOAPException
public ThemeInfo getTheme(java.lang.String storeId) throws javax.xml.soap.SOAPException
storeId
- The store id of the theme.javax.xml.soap.SOAPException
public java.lang.String getWorkbook(java.lang.String workbookName) throws javax.xml.soap.SOAPException
workbookName
- A name of an app.javax.xml.soap.SOAPException
public java.util.List<java.lang.String> listApps() throws javax.xml.soap.SOAPException
javax.xml.soap.SOAPException
public java.util.List<MediaInfo> listMedia(java.lang.String name, java.lang.String category, java.lang.String storeId) throws javax.xml.soap.SOAPException
name
- The media item name.category
- The media item category.storeId
- The store id of the media item.javax.xml.soap.SOAPException
public java.util.List<PBLPagePropertiesInfo> listPBLPages(int pageIndex, int pageSize) throws javax.xml.soap.SOAPException
pageIndex
- The page index.pageSize
- A number of items returned for a single request.PBLPagePropertiesInfo
objects describing PBL pages.javax.xml.soap.SOAPException
public java.util.List<PBLPagePropertiesInfo> listPBLPages(int pageIndex, int pageSize, java.lang.Boolean omitVersionIds, java.lang.Boolean includePblMarkup) throws javax.xml.soap.SOAPException
pageIndex
- The page index.pageSize
- The number of items returned for a single request.omitVersionIds
- A flag to indicate whether or not the version Ids should be returned. Is a performance improvement if this value will be ignoredincludePblMarkup
- A flag to indicate whether or not the pbl markup is returned.PBLPagePropertiesInfo
objects describing PBL pages.javax.xml.soap.SOAPException
public java.util.List<PBLPageVersionInfo> listPBLPageVersions(java.lang.String pageName) throws javax.xml.soap.SOAPException
pageName
- A name of the PBL page.PBLPageVersionInfo
object containing the version information for the the PBL page.javax.xml.soap.SOAPException
public java.util.ArrayList<ThemeInfo> listThemes(java.lang.String filter, int pageIndex, int pageSize) throws javax.xml.soap.SOAPException
filter
- A filter expression.pageIndex
- The page index.pageSize
- A number of items returned for a single request.javax.xml.soap.SOAPException
public java.lang.String putMedia(java.lang.String storeId, java.lang.String name, java.lang.String category, java.lang.String filePath) throws java.io.IOException, RqlApiException
storeId
- The store id of the media item.name
- A name of the media item.category
- The media item category.filePath
- A full path to the media file to upload.java.io.IOException
RqlApiException
public java.lang.String putPBLPage(java.lang.String controlPblMarkupHash, java.lang.String pageName, java.lang.String pblMarkup) throws javax.xml.soap.SOAPException
controlPblMarkupHash
- The control hash of a markup. The page markup should have the same hash as provided control hash.pageName
- A name of the PBL page.pblMarkup
- The contents of the PBL page.javax.xml.soap.SOAPException
public java.lang.String putTheme(ThemeInfo themeInfo) throws javax.xml.soap.SOAPException
themeInfo
- A ThemeInfo
object.javax.xml.soap.SOAPException
public java.util.List<java.lang.String> listDictionaries() throws javax.xml.soap.SOAPException
javax.xml.soap.SOAPException
public void deleteDictionary(java.lang.String fileName) throws RqlApiException
fileName
- The name of the dictionary file to delete.RqlApiException
public void uploadDictionary(java.lang.String filePath) throws java.io.IOException, RqlApiException
filePath
- The full path to the dictionary file to upload.java.io.IOException
RqlApiException
public java.io.InputStream getDictionary(java.lang.String fileName) throws java.io.IOException, RqlApiException
fileName
- The file name of the dictionary.java.io.IOException
RqlApiException