Skip navigation links

Oracle® Imaging and Process Management Java API Reference
11g Release 1 (11.1.1)

E12853-01


oracle.imaging
Class ServicesFactory

java.lang.Object
  extended by oracle.imaging.ServicesFactory


public abstract class ServicesFactory
extends java.lang.Object

Constructor Summary
ServicesFactory()
           

 

Method Summary
protected abstract  void authenticate(UserToken credentials, java.util.Locale locale)
          An abstract method that is called by during login to perform authentication.
protected abstract  ApplicationService createApplicationService()
          An abstract method that derived classes must implement to create a concrete application service implementation.
protected abstract  BatchService createBatchService()
          This method is reserved for Oracle internal use only.
protected abstract  ConnectionService createConnectionService()
          An abstract method that derived classes must implement to create a concrete connection service implementation.
protected abstract  DocumentContentService createDocumentContentService()
          An abstract method that derived classes must implement to create a concrete document content service implementation.
protected abstract  DocumentService createDocumentService()
          An abstract method that derived classes must implement to create a concrete document service implementation.
protected abstract  ImportExportService createImportExportService()
          An abstract method that derived classes must implement to create a concrete import/export service implementation.
protected abstract  InputService createInputService()
          An abstract method that derived classes must implement to create a concrete input service implementation.
protected abstract  LifecycleService createLifecycleService()
          An abstract method that derived classes must implement to create a concrete lifecycle service implementation.
protected abstract  PreferenceService createPreferenceService()
          An abstract method that derived classes must implement to create a concrete preference service implementation.
protected abstract  SearchService createSearchService()
          An abstract method that derived classes must implement to create a concrete search service implementation.
protected abstract  SecurityService createSecurityService()
          An abstract method that derived classes must implement to create a concrete security service implementation.
protected abstract  TicketService createTicketService()
          An abstract method that derived classes must implement to create a concrete ticket service implementation.
protected abstract  void deauthenticate()
           
 ApplicationService getApplicationService()
          Gets the Application service for the Imaging System.
 BatchService getBatchService()
          This method is reserved for Oracle internal use only.
 ConnectionService getConnectionService()
          Gets a ConnectionService that can be used for manipulating Connections.
 DocumentContentService getDocumentContentService()
          Gets a DocumentContentService that can be used for accessing and manipulating documents.
 DocumentService getDocumentService()
          Gets a DocumentService that can be used for accessing and manipulating documents.
 ImportExportService getImportExportService()
          Gets a ImportExportService that can be used for importing and exporting definitions.
 InputService getInputService()
          This method get an InputService that can be used for accessing and manipulating Input definitions.
 LifecycleService getLifecycleService()
          Gets a LifecycleService.
 PreferenceService getPreferenceService()
          Gets a PreferenceService that can be used for accessing preference information.
 SearchService getSearchService()
          Gets the Search service for the Imaging System.
 SecurityService getSecurityService()
          Gets a SecurityService that can be used for accessing security information.
 TicketService getTicketService()
          Gets a TicketService that can be used for manipulating URL Tickets.
abstract  SecurityMember getUserInfo()
          Gets the information of the current user logged in.
static ServicesFactory login(UserToken credentials, java.util.Locale locale)
          A static method that performs an in process login.
static ServicesFactory login(UserToken credentials, java.util.Locale locale, java.lang.String url)
          A static method that performs a remote login.
 void logout()
          Logs out the current user

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

ServicesFactory

public ServicesFactory()

Method Detail

authenticate

protected abstract void authenticate(UserToken credentials,
                                     java.util.Locale locale)
                              throws ImagingException
An abstract method that is called by during login to perform authentication. Derived, concrete classes must implement this method to pass credentials into the sevices session state.
Parameters:
credentials - The credentials to be used for authentication
Throws:
ImagingException

deauthenticate

protected abstract void deauthenticate()
                                throws ImagingException
Throws:
ImagingException

createApplicationService

protected abstract ApplicationService createApplicationService()
                                                        throws ImagingException
An abstract method that derived classes must implement to create a concrete application service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
ImagingException

createSearchService

protected abstract SearchService createSearchService()
                                              throws ImagingException
An abstract method that derived classes must implement to create a concrete search service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
ImagingException

createInputService

protected abstract InputService createInputService()
                                            throws ImagingException
An abstract method that derived classes must implement to create a concrete input service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
java.lang.Exception
ImagingException

createDocumentContentService

protected abstract DocumentContentService createDocumentContentService()
                                                                throws ImagingException
An abstract method that derived classes must implement to create a concrete document content service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
java.lang.Exception
ImagingException

createDocumentService

protected abstract DocumentService createDocumentService()
                                                  throws ImagingException
An abstract method that derived classes must implement to create a concrete document service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
java.lang.Exception
ImagingException

createSecurityService

protected abstract SecurityService createSecurityService()
                                                  throws ImagingException
An abstract method that derived classes must implement to create a concrete security service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
ImagingException

createPreferenceService

protected abstract PreferenceService createPreferenceService()
                                                      throws ImagingException
An abstract method that derived classes must implement to create a concrete preference service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
ImagingException

createImportExportService

protected abstract ImportExportService createImportExportService()
                                                          throws ImagingException
An abstract method that derived classes must implement to create a concrete import/export service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
ImagingException

createBatchService

protected abstract BatchService createBatchService()
                                            throws ImagingException
This method is reserved for Oracle internal use only.
Throws:
ImagingException

createLifecycleService

protected abstract LifecycleService createLifecycleService()
                                                    throws ImagingException
An abstract method that derived classes must implement to create a concrete lifecycle service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
ImagingException

createTicketService

protected abstract TicketService createTicketService()
                                              throws ImagingException
An abstract method that derived classes must implement to create a concrete ticket service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
ImagingException

createConnectionService

protected abstract ConnectionService createConnectionService()
                                                      throws ImagingException
An abstract method that derived classes must implement to create a concrete connection service implementation.
Returns:
A concrete service implementing the service endpoint interface
Throws:
ImagingException

logout

public void logout()
            throws ImagingException
Logs out the current user
Throws:
ImagingException

getApplicationService

public ApplicationService getApplicationService()
                                         throws ImagingException
Gets the Application service for the Imaging System.
Returns:
The Application service for the Imaging System.
Throws:
ImagingException

getSearchService

public SearchService getSearchService()
                               throws ImagingException
Gets the Search service for the Imaging System.
Returns:
The Search service for the Imaging System.
Throws:
ImagingException

getInputService

public InputService getInputService()
                             throws ImagingException
This method get an InputService that can be used for accessing and manipulating Input definitions.
Returns:
An instance of an InputService.
Throws:
ImagingException

getDocumentContentService

public DocumentContentService getDocumentContentService()
                                                 throws ImagingException
Gets a DocumentContentService that can be used for accessing and manipulating documents.
Returns:
An instance of DocumentContentService.
Throws:
ImagingException

getDocumentService

public DocumentService getDocumentService()
                                   throws ImagingException
Gets a DocumentService that can be used for accessing and manipulating documents.
Returns:
An instance of DocumentService.
Throws:
ImagingException

getSecurityService

public SecurityService getSecurityService()
                                   throws ImagingException
Gets a SecurityService that can be used for accessing security information.
Returns:
An instance of SecurityService.
Throws:
ImagingException

getPreferenceService

public PreferenceService getPreferenceService()
                                       throws ImagingException
Gets a PreferenceService that can be used for accessing preference information.
Returns:
An instance of PreferenceService.
Throws:
ImagingException

getImportExportService

public ImportExportService getImportExportService()
                                           throws ImagingException
Gets a ImportExportService that can be used for importing and exporting definitions.
Returns:
An instance of ImportExportService.
Throws:
ImagingException

getBatchService

public BatchService getBatchService()
                             throws ImagingException
This method is reserved for Oracle internal use only.
Throws:
ImagingException

getLifecycleService

public LifecycleService getLifecycleService()
                                     throws ImagingException
Gets a LifecycleService.
Returns:
An instance of a LifecycleService.
Throws:
ImagingException

getTicketService

public TicketService getTicketService()
                               throws ImagingException
Gets a TicketService that can be used for manipulating URL Tickets.
Returns:
An instance of a TicketService.
Throws:
ImagingException

getConnectionService

public ConnectionService getConnectionService()
                                       throws ImagingException
Gets a ConnectionService that can be used for manipulating Connections.
Returns:
An instance of a ConnectionService.
Throws:
ImagingException

login

public static ServicesFactory login(UserToken credentials,
                                    java.util.Locale locale)
                             throws ImagingException
A static method that performs an in process login.
Parameters:
credentials - The credentials to be used for authentication.
Returns:
A concrete ServicesFactory implementation that produces inprocess service instances.
Throws:
ImagingException

login

public static ServicesFactory login(UserToken credentials,
                                    java.util.Locale locale,
                                    java.lang.String url)
                             throws ImagingException
A static method that performs a remote login.
Parameters:
credentials - The credentials to be used for authentication.
url - The url to the imaging services system
Returns:
A concrete ServicesFactory implementation that produces proxy service instances.
Throws:
ImagingException

getUserInfo

public abstract SecurityMember getUserInfo()
                                    throws ImagingException
Gets the information of the current user logged in.
Returns:
SecurityMember object containing the current user information.
Throws:
ImagingException

Skip navigation links

Oracle® Imaging and Process Management Java API Reference
11g Release 1 (11.1.1)

E12853-01


Copyright © 2010, Oracle. All rights reserved.