|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.sree.soap.SoapRepository
public class SoapRepository
Soap Service for the RepletRepository.
| Field Summary | |
|---|---|
static String |
AUTHENTICATION_FAILURE
|
static String |
LOGIN_FAILURE
|
| Constructor Summary | |
|---|---|
SoapRepository()
Default Constructor. |
|
| Method Summary | |
|---|---|
boolean |
deleteReplet(String ticket,
RepositoryEntryStruct entryst)
Delete a replet. |
boolean |
deleteRepletByName(String ticket,
String name)
Delete a replet. |
void |
destroyReplet(String ticket,
String repletId)
Destroy a replet instance. |
String |
executeReplet(String ticket,
String name,
RepletType type,
RepletRequestStruct requestStruct)
Execute a replet and store it in a server side cache. |
String |
export(String ticket,
String repletId,
FormatType format)
Export a replet to the specified format. |
inetsoft.sree.soap.store.ArchiveOptionType |
getArchiveOption(String ticket)
Get the type of archive that is supported. |
String |
getArchiveReport(String ticket,
String path,
String ver)
Get the a archive report with the name. |
RepositoryEntryStruct[] |
getFolders(String ticket,
String permission)
Get the list of all folders. |
int |
getPageCount(String ticket,
String repletId)
Get the number of pages in a report. |
String[] |
getPrinters(String ticket)
Get the names of all printers available to the server. |
String[] |
getPrototypes(String ticket)
Get the names of all prototypes. |
RepletParametersStruct |
getRepletParameters(String ticket,
String repletName)
Get the parameters of a replet. |
RepositoryEntryStruct[] |
getReplets(String ticket,
String permission)
Get the list of all replets. |
RepositoryEntryStruct[] |
getRepositoryEntries(String ticket,
String folder,
String permission,
EntryType selector)
Get available repository entries. |
long |
getResourceLength(String ticket,
String resourceID)
Get the size, in bytes, of the specified resource. |
inetsoft.sree.soap.schedule.ScheduleTaskStruct |
getScheduledTask(String ticket,
String name)
Get the scheduled task with a specific name. |
String[] |
getScheduleTasks(String ticket)
Get a list of schedule tasks available to the specified user. |
String |
login(String username,
String password,
String locale)
Login returns a ticket for client use in subsequent communications with the server. |
void |
logout(String ticket)
Log off a user. |
boolean |
mailTo(String ticket,
String repletId,
String recipients,
String from,
String subject,
String msg,
FormatType fmt)
Send a replet via email. |
byte[] |
nextBlock(String ticket,
String resourceID)
Get the next block of data in a specified resource. |
void |
print(String ticket,
String repletId,
String printer,
int[] pageList)
Print a range of pages of a replet to the specified server printer. |
void |
removeScheduleTask(String ticket,
String name)
Remove a scheduled task. |
void |
saveInArchive(String ticket,
String repletId,
String path,
FormatType format,
inetsoft.sree.soap.security.PermissionStruct permissionStruct,
inetsoft.sree.soap.store.ArchiveRuleStruct ruleStruct,
String comment)
Save a replet instance in the report archive. |
void |
setScheduleTask(String ticket,
String name,
inetsoft.sree.soap.schedule.ScheduleTaskStruct taskStruct)
Save a schedule task. |
void |
updateScheduledTask(String ticket,
String name,
inetsoft.sree.soap.schedule.ScheduleTaskStruct taskStruct)
Update a schedule task (overwrite it) |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String LOGIN_FAILURE
public static final String AUTHENTICATION_FAILURE
| Constructor Detail |
|---|
public SoapRepository()
| Method Detail |
|---|
public String login(String username,
String password,
String locale)
login in interface SoapRepositoryServiceusername - A registered username. If security is turned off, this
can be any value except null.password - Corresponding password for the username. If security is
turned off, this can be any value except null.locale - the locale of the user.
public void logout(String ticket)
logout in interface SoapRepositoryServiceticket - This ticket will be permanently invalidated and removed
from the system.
public String executeReplet(String ticket,
String name,
RepletType type,
RepletRequestStruct requestStruct)
executeReplet in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.name - the name of the replet to create.type - the type of replet being created.requestStruct - a RepletRequest object containing the report parameters.
public void destroyReplet(String ticket,
String repletId)
destroyReplet in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.repletId - the replet instance ID.
public int getPageCount(String ticket,
String repletId)
getPageCount in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.repletId - the replet instance ID.
public boolean mailTo(String ticket,
String repletId,
String recipients,
String from,
String subject,
String msg,
FormatType fmt)
mailTo in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.repletId - the instance ID of the replet to send.recipients - the email address(es) of the recipients of the email
message.from - the from text of the email header.subject - the subject line of the email message.msg - the body text of the email message.fmt - the file format in which to send the report.
Allowed values are the file format constants defined in
FormatEnum.
public String export(String ticket,
String repletId,
FormatType format)
nextBlock method with the returned resource ID.
export in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.repletId - the instance ID of the replet to export.format - the file format in which to export the replet. This must be
one of the file format constants defined in
FormatEnum.
public long getResourceLength(String ticket,
String resourceID)
getResourceLength in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.resourceID - the ID of the resource, as returned by the
export method.
public byte[] nextBlock(String ticket,
String resourceID)
nextBlock in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.resourceID - the ID of the resource, as returned by the
export method.
null if no more data
is available.public String[] getPrinters(String ticket)
getPrinters in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.
public void print(String ticket,
String repletId,
String printer,
int[] pageList)
print in interface SoapRepositoryServicerepletId - the instance ID of the replet to print.printer - the name of the printer on which to print the replet.pageList - the indexes of the pages to print. If this parameter is
null, all pages will be printed.
RepletException - if the replet could not be printed.
RemoteException - if an unspecified error occurs.public inetsoft.sree.soap.store.ArchiveOptionType getArchiveOption(String ticket)
getArchiveOption in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.
NO_ARCHIVE, DEFAULT_ARCHIVE, or
VERSIONED_ARCHIVE.
public void saveInArchive(String ticket,
String repletId,
String path,
FormatType format,
inetsoft.sree.soap.security.PermissionStruct permissionStruct,
inetsoft.sree.soap.store.ArchiveRuleStruct ruleStruct,
String comment)
saveInArchive in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.repletId - the replet instance ID.path - the archive path to which to save the report.format - the file format in which to save the report. This must be
one of the file formats defined in
FormatEnum.permissionStruct - the permission to be granted on the saved report.ruleStruct - the archive rule for the saved report.comment - a description of the saved report.
public inetsoft.sree.soap.schedule.ScheduleTaskStruct getScheduledTask(String ticket,
String name)
getScheduledTask in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.name - The name if the task.
public String getArchiveReport(String ticket,
String path,
String ver)
getArchiveReport in interface SoapRepositoryServiceticket - authentication ticket.path - archived report path.ver - archived report version, will be ignored if
not using versioned archive. Pass null
that case.
public String[] getScheduleTasks(String ticket)
getScheduleTasks in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.
public void setScheduleTask(String ticket,
String name,
inetsoft.sree.soap.schedule.ScheduleTaskStruct taskStruct)
setScheduleTask in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.name - the name of the saved task.taskStruct - the ScheduleTask object to save.
public void updateScheduledTask(String ticket,
String name,
inetsoft.sree.soap.schedule.ScheduleTaskStruct taskStruct)
updateScheduledTask in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.name - the name of the saved task.taskStruct - the ScheduleTask object to save.
public void removeScheduleTask(String ticket,
String name)
removeScheduleTask in interface SoapRepositoryServiceticket - A valid ticket obtained upon successful login.name - the name of the task to remove.
public RepositoryEntryStruct[] getFolders(String ticket,
String permission)
getFolders in interface SoapRepositoryServiceticket - the valid ticket obtained upon successful login.permission - the permissions the user must have on a folder in order
for it to be returned. Should be a combination of 'r',
'w', and 'd', which stand for read, write, and
delete respectively. If this parameter is null, all folders
that the user has any permission on are returned.
RemoteException - if an error occurs while getting the folder list.
public RepositoryEntryStruct[] getReplets(String ticket,
String permission)
getReplets in interface SoapRepositoryServiceticket - the valid ticket obtained upon successful login.permission - the permissions the user must have on a replet in order
for it to be returned. Should be a combination of 'r',
'w', and 'd', which stand for read, write, and
delete respectively. If this parameter is null, all replets
that the user has any permission on are returned.
RemoteException - if an error occurs while getting the replet list.
public RepositoryEntryStruct[] getRepositoryEntries(String ticket,
String folder,
String permission,
EntryType selector)
getRepositoryEntries in interface SoapRepositoryServiceticket - the valid ticket obtained upon successful login.folder - the specified parent folder.permission - the permissions the user must have on an entry in order
for it to be returned. Should be a combination of 'r',
'w', and 'd', which stand for read, write, and
delete respectively. If this parameter is null, all entries
that the user has any permission on are returned.selector - the specified selector, should be one of the repository
entry types predefined in RepositoryEntry like FOLDER.
The selector may be an OR combination of the types as well.
public boolean deleteRepletByName(String ticket,
String name)
deleteRepletByName in interface SoapRepositoryServiceticket - the valid ticket obtained upon successful login.name - the path of the replet.
public boolean deleteReplet(String ticket,
RepositoryEntryStruct entryst)
deleteReplet in interface SoapRepositoryServiceticket - the valid ticket obtained upon successful login.entryst - the repository entry struct.
public RepletParametersStruct getRepletParameters(String ticket,
String repletName)
getRepletParameters in interface SoapRepositoryServiceticket - the valid ticket obtained upon successful login.repletName - the replet name.public String[] getPrototypes(String ticket)
getPrototypes in interface SoapRepositoryServiceticket - the valid ticket obtained upon successful login.
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||