Style Intelligence v12.0

inetsoft.sree.soap
Interface SoapRepositoryService

All Known Implementing Classes:
SoapRepository

public interface SoapRepositoryService

Soap Service for the RepletRepository.


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)
 

Method Detail

login

String login(String username,
             String password,
             String locale)
             throws RemoteException
Login returns a ticket for client use in subsequent communications with the server. This ticket is used to refer to a Principal object stored in the server. Every other web method will require the client to have previously logged in

Parameters:
username - 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.
Returns:
session ticket. This ticket is required when calling any other web methods defined in this service.
Throws:
RemoteException

logout

void logout(String ticket)
            throws RemoteException
Log off a user. Invalidates the session ticket passed as a parameter

Parameters:
ticket - This ticket will be permanently invalidated and removed from the system.
Throws:
RemoteException

executeReplet

String executeReplet(String ticket,
                     String name,
                     RepletType type,
                     RepletRequestStruct requestStruct)
                     throws RemoteException
Execute a replet and store it in a server side cache.

Parameters:
ticket - 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.
Returns:
RepletID for use in subsequent transactions
Throws:
RemoteException

destroyReplet

void destroyReplet(String ticket,
                   String repletId)
                   throws RemoteException
Destroy a replet instance. If the specified replet is in the process of generating pages, it is interrupted.

Parameters:
ticket - A valid ticket obtained upon successful login.
repletId - the replet instance ID.
Throws:
RemoteException

getPageCount

int getPageCount(String ticket,
                 String repletId)
                 throws RemoteException
Get the number of pages in a report.

Parameters:
ticket - A valid ticket obtained upon successful login.
repletId - the replet instance ID.
Returns:
the number of pages in the report.
Throws:
RemoteException

print

void print(String ticket,
           String repletId,
           String printer,
           int[] pageList)
           throws RemoteException
Print a range of pages of a replet to the specified server printer.

Parameters:
repletId - 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.
Throws:
RepletException - if the replet could not be printed.
RemoteException - if an unspecified error occurs.

mailTo

boolean mailTo(String ticket,
               String repletId,
               String recipients,
               String from,
               String subject,
               String msg,
               FormatType fmt)
               throws RemoteException
Send a replet via email.

Parameters:
ticket - 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.
Throws:
RemoteException

export

String export(String ticket,
              String repletId,
              FormatType format)
              throws RemoteException
Export a replet to the specified format. The exported file is cached internally. The cached file can be retrieved by calling the nextBlock method with the returned resource ID.

Parameters:
ticket - 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.
Returns:
the resource ID of the exported file.
Throws:
RemoteException

getResourceLength

long getResourceLength(String ticket,
                       String resourceID)
                       throws RemoteException
Get the size, in bytes, of the specified resource.

Parameters:
ticket - A valid ticket obtained upon successful login.
resourceID - the ID of the resource, as returned by the export method.
Returns:
the size of the resource.
Throws:
RemoteException

nextBlock

byte[] nextBlock(String ticket,
                 String resourceID)
                 throws RemoteException
Get the next block of data in a specified resource.

Parameters:
ticket - A valid ticket obtained upon successful login.
resourceID - the ID of the resource, as returned by the export method.
Returns:
the next block of bytes, or null if no more data is available.
Throws:
RemoteException

getPrinters

String[] getPrinters(String ticket)
                     throws RemoteException
Get the names of all printers available to the server.

Parameters:
ticket - A valid ticket obtained upon successful login.
Returns:
the list of all available printers.
Throws:
RemoteException

getArchiveOption

inetsoft.sree.soap.store.ArchiveOptionType getArchiveOption(String ticket)
                                                            throws RemoteException
Get the type of archive that is supported.

Parameters:
ticket - A valid ticket obtained upon successful login.
Returns:
NO_ARCHIVE, DEFAULT_ARCHIVE, or VERSIONED_ARCHIVE.
Throws:
RemoteException

saveInArchive

void saveInArchive(String ticket,
                   String repletId,
                   String path,
                   FormatType format,
                   inetsoft.sree.soap.security.PermissionStruct permissionStruct,
                   inetsoft.sree.soap.store.ArchiveRuleStruct ruleStruct,
                   String comment)
                   throws RemoteException
Save a replet instance in the report archive.

Parameters:
ticket - 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.
Throws:
RemoteException

getArchiveReport

String getArchiveReport(String ticket,
                        String path,
                        String ver)
                        throws RemoteException
Get the a archive report with the name.

Parameters:
ticket - authentication ticket.
path - archived report path.
ver - archived report version, will be ignored if not using versioned archive. Pass null that case.
Returns:
string id representing archived report.
Throws:
RemoteException

getScheduledTask

inetsoft.sree.soap.schedule.ScheduleTaskStruct getScheduledTask(String ticket,
                                                                String name)
                                                                throws RemoteException
Get the scheduled task with a specific name.

Parameters:
ticket - A valid ticket obtained upon successful login.
name - The name if the task.
Returns:
a ScheduleTaskStruct
Throws:
RemoteException

getScheduleTasks

String[] getScheduleTasks(String ticket)
                          throws RemoteException
Get a list of schedule tasks available to the specified user.

Parameters:
ticket - A valid ticket obtained upon successful login.
Returns:
a list of task names.
Throws:
RemoteException

setScheduleTask

void setScheduleTask(String ticket,
                     String name,
                     inetsoft.sree.soap.schedule.ScheduleTaskStruct taskStruct)
                     throws RemoteException
Save a schedule task.

Parameters:
ticket - A valid ticket obtained upon successful login.
name - the name of the saved task.
taskStruct - the ScheduleTask object to save.
Throws:
RemoteException

updateScheduledTask

void updateScheduledTask(String ticket,
                         String name,
                         inetsoft.sree.soap.schedule.ScheduleTaskStruct taskStruct)
                         throws RemoteException
Update a schedule task (overwrite it)

Parameters:
ticket - A valid ticket obtained upon successful login.
name - the name of the saved task.
taskStruct - the ScheduleTask object to save.
Throws:
RemoteException

removeScheduleTask

void removeScheduleTask(String ticket,
                        String name)
                        throws RemoteException
Remove a scheduled task.

Parameters:
ticket - A valid ticket obtained upon successful login.
name - the name of the task to remove.
Throws:
RemoteException

getFolders

RepositoryEntryStruct[] getFolders(String ticket,
                                   String permission)
                                   throws RemoteException
Get the list of all folders.

Parameters:
ticket - 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.
Returns:
a list of RepositoryEntry objects that represent the folders that are registered.
Throws:
RemoteException - if an error occurs while getting the folder list.

getReplets

RepositoryEntryStruct[] getReplets(String ticket,
                                   String permission)
                                   throws RemoteException
Get the list of all replets.

Parameters:
ticket - 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.
Returns:
a list of RepositoryEntry objects that represent the replets that are registered.
Throws:
RemoteException - if an error occurs while getting the replet list.

getRepositoryEntries

RepositoryEntryStruct[] getRepositoryEntries(String ticket,
                                             String folder,
                                             String permission,
                                             EntryType selector)
                                             throws RemoteException
Get available repository entries.

Parameters:
ticket - 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.
Throws:
RemoteException

deleteRepletByName

boolean deleteRepletByName(String ticket,
                           String name)
                           throws RemoteException
Delete a replet.

Parameters:
ticket - the valid ticket obtained upon successful login.
name - the path of the replet.
Throws:
RemoteException

deleteReplet

boolean deleteReplet(String ticket,
                     RepositoryEntryStruct entryst)
                     throws RemoteException
Delete a replet.

Parameters:
ticket - the valid ticket obtained upon successful login.
entryst - the repositoryentrystruct.
Throws:
RemoteException

getRepletParameters

RepletParametersStruct getRepletParameters(String ticket,
                                           String repletName)
                                           throws RemoteException
Get the parameters of a replet.

Parameters:
ticket - the valid ticket obtained upon successful login.
repletName - the repositoryentrystruct.
Throws:
RemoteException

getPrototypes

String[] getPrototypes(String ticket)
                       throws RemoteException
Get the names of all prototypes.

Parameters:
ticket - the valid ticket obtained upon successful login.
Throws:
RemoteException

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.