|
| Foundation |
|
| |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||||
com.sas.services.publish.TransportFactory
public class TransportFactory
A factory used to manufacture delivery transport objects. Each delivery
transport implements the TransportInterface.
A delivery transport is a method of delivering a result set package to the
consumer. Each delivery transport provides a mechanism for publishing the
result package and retrieving a result package. How the result package is
delivered is transport-specific.
The supported delivery transports are listed below. View the javadoc for specific details on each delivery transport.
| Constructor Summary | |
|---|---|
TransportFactory()
|
|
| Constructor Detail |
|---|
public TransportFactory()
| Method Detail |
|---|
public ArchiveTransportInterface getArchiveTransport(java.io.File file,
LoggerInterface logger,
SessionContextInterface sessionContext)
throws TransportException
getArchiveTransport(File, SessionContextInterface)
Session-based applications can specify a session context. When a result package is retrieved from an archive, the archive transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
By default, the publish services will not provide any logging. The publish services will
utilize logging only if a session context or a logger is specified. If a logger is specified,
it will take precedence and will be used for logging publish activities. If a session context
is specified but the logger is null, the logger contained within the session
context will be used for logging purposes.
file - The archive file (.spk). If publishing, this is the archive file to create. If
retrieving a result package, this is the existing archive file (.spk).logger - The logger to use for logging publish activity. This can be null.sessionContext - The session context. This can be null.
java.lang.IllegalArgumentException - If a null file is specified.
TransportException - If an error occurs initializing the transport.
public ArchiveTransportInterface getArchiveTransport(java.io.File file,
SessionContextInterface sessionContext)
throws TransportException
Session-based applications can specify a session context. When a result package is retrieved from an archive, the archive transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
file - The archive file (.spk). If publishing, this is the archive
file to create. If retrieving a result package, this is the
existing archive file (.spk).sessionContext - The session context. This can be null.
java.lang.IllegalArgumentException - If a null file is specified.
TransportException - If an error occurs initializing the transport.
public DAVTransportInterface getDAVTransport(java.lang.String url,
java.lang.String domain,
LoggerInterface logger,
SessionContextInterface sessionContext)
throws TransportException
getDAVTransport(String, String, SessionContextInterface)
Session-based applications can specify a session context. The user context contained within the session context, along with the authentication domain, will be used to determine the credentials that will be used when binding to the webDAV server. When a result package is retrieved from a WebDAV server, the WebDAV transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
By default, the publish services will not provide any logging. The publish services will
utilize logging only if a session context or a logger is specified. If a logger is specified,
it will take precedence and will be used for logging publish activities. If a session context
is specified but the logger is null, the logger contained within the session
context will be used for logging purposes.
url - The URL. If publishing, the URL identifies the collection where the result package
will be published. If retrieving an existing result package, this URL identifies
the collection/result package to retrieve.domain - The authentication domain. This can be null.logger - The logger to use for logging publish activity. This can be null.sessionContext - The session context. This can be null.
TransportException - If an error occurs initializing the transport.
public DAVTransportInterface getDAVTransport(java.lang.String url,
java.lang.String domain,
SessionContextInterface sessionContext)
throws TransportException
Session-based applications can specify a session context. The user context contained within the session context, along with the authentication domain, will be used to determine the credentials that will be used when binding to the webDAV server. When a result package is retrieved from a WebDAV server, the WebDAV transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
url - The URL. If publishing, the URL identifies the collection where
the result package will be published. If retrieving an existing
result package, this URL identifies the collection/result
package to retrieve.domain - The authentication domain. This can be null.sessionContext - The session context. This can be null.
TransportException - If an error occurs initializing the transport.
public DAVTransportInterface getDAVTransport(java.lang.String url,
java.lang.String username,
java.lang.String password,
LoggerInterface logger,
SessionContextInterface sessionContext)
throws TransportException
getDAVTransportWithCredentials(String, String, String, SessionContextInterface)
Session-based applications can specify a session context. When a result package is retrieved from a WebDAV server, the WebDAV transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
By default, the publish services will not provide any logging. The publish services will
utilize logging only if a session context or a logger is specified. If a logger is specified,
it will take precedence and will be used for logging publish activities. If a session context
is specified but the logger is null, the logger contained within the session
context will be used for logging purposes.
url - The URL. If publishing, the URL identifies the collection where the result package
will be published. If retrieving an existing result package, this URL identifies
the collection/result package to retrieve.username - The user name. This can be null.password - The password. This can be null.logger - The logger to use for logging publish activity. This can be null.sessionContext - The session context. This can be null.
TransportException - If an error occurs initializing the transport.
public DAVTransportInterface getDAVTransportWithCredentials(java.lang.String url,
java.lang.String username,
java.lang.String password,
SessionContextInterface sessionContext)
throws TransportException
Session-based applications can specify a session context. When a result package is retrieved from a WebDAV server, the WebDAV transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
url - The URL. If publishing, the URL identifies the collection where
the result package will be published. If retrieving an existing
result package, this URL identifies the collection/result
package to retrieve.username - The user name. This can be null.password - The password. This can be null.sessionContext - The session context. This can be null.
TransportException - If an error occurs initializing the transport.
public DAVTransportInterface getDAVTransport(ContentDestination content,
LoggerInterface logger,
SessionContextInterface sessionContext)
throws TransportException
getDAVTransport(ContentDestination, SessionContextInterface)
com.sas.services.information.metadata.SubscriberInterface). The content
destination of a subscriber identifies all the information needed to publish to WebDAV. It
includes the relative path of the subscriber, the HTTP server, and the domain information.
Session-based applications can specify a session context. If the WebDAV server identified by the ContentDestination is configured for user/password authentication, then the user context contained within the session context, along with the authentication domain, will be used to determine the credentials that will be used when binding to the webDAV server. If the WebDAV server identified by the ContentDestination is configured for metadata authentication, then a OTP will be generated when binding to the WebDAV Server.
When a result package is retrieved from a WebDAV server, the WebDAV transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
By default, the publish services will not provide any logging. The publish services will
utilize logging only if a session context or a logger is specified. If a logger is specified,
it will take precedence and will be used for logging publish activities. If a session context
is specified but the logger is null, the logger contained within the session
context will be used for logging purposes.
content - The ContentDestination that identifies the WebDAV server information.logger - The logger to use for logging publish activity. This can be null.sessionContext - The session context. This can be null.
TransportException - If an error occurs initializing the transport.
public DAVTransportInterface getDAVTransport(ContentDestination content,
SessionContextInterface sessionContext)
throws TransportException
com.sas.services.information.metadata.SubscriberInterface).
The content destination of a subscriber identifies all the information
needed to publish to WebDAV. It includes the relative path of the
subscriber, the HTTP server, and the domain information.
Session-based applications can specify a session context. If the WebDAV server identified by the ContentDestination is configured for user/password authentication, then the user context contained within the session context, along with the authentication domain, will be used to determine the credentials that will be used when binding to the webDAV server. If the WebDAV server identified by the ContentDestination is configured for metadata authentication, then a OTP will be generated when binding to the WebDAV Server.
When a result package is retrieved from a WebDAV server, the WebDAV transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
content - The ContentDestination that identifies the WebDAV server
information.sessionContext - The session context. This can be null.
TransportException - If an error occurs initializing the transport.
public RequesterTransportInterface getRequesterTransport(com.sas.iom.SAS.IResultPackage resultPackage,
LoggerInterface logger,
SessionContextInterface sessionContext)
throws TransportException
getRequesterTransport(IResultPackage, SessionContextInterface)
By default, the publish services will not provide any logging. The publish services will
utilize logging only if a session context or a logger is specified. If a logger is specified,
it will take precedence and will be used for logging publish activities. If a session context
is specified but the logger is null, the logger contained within the session
context will be used for logging purposes.
resultPackage - the IResultPackagelogger - The logger to use for logging publish activity. This can be null.sessionContext - The session context. This can be null
TransportException - If an error occurs initializing the transport.
public RequesterTransportInterface getRequesterTransport(com.sas.iom.SAS.IResultPackage resultPackage,
SessionContextInterface sessionContext)
throws TransportException
resultPackage - the IResultPackagesessionContext - The session context. This can be null
TransportException - If an error occurs initializing the transport.
public RequesterTransportInterface getRequesterTransport(com.sas.iom.SAS.IWorkspace workspace,
java.lang.String transportInformation,
java.lang.String[][] properties,
LoggerInterface logger,
SessionContextInterface sessionContext)
throws TransportException
getRequesterTransport(IWorkspace, String, String[][], SessionContextInterface)
The following is excerpted from the doc for IOM's BrowseResultPackage which is used by this method:
The result package may be identified by physical path and filename, excluding any extension, or it may be an LDAP URL that contains the distinguished name of the sasArchive entry. If the LDAP server is secure, the LDAP URL may contain the bind distinguished name and password as shown in the document LDAP Channel Store Syntax. Or, "BINDDN" and "PASSWORD" may be specified as properties via the third (properties) parameter.
Session-based applications can specify a session context. The logger contained within the session context will be used by the publishing services to log publishing activity. Additionally, when a result package is retrieved, the requester transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
By default, the publish services will not provide any logging. The publish services will
utilize logging only if a session context or a logger is specified. If a logger is specified,
it will take precedence and will be used for logging publish activities. If a session context
is specified but the logger is null, the logger contained within the session
context will be used for logging purposes.
workspace - the IWorkspace which provides the connectiontransportInformation - transport informationproperties - if needed by the transport; null otherwise.logger - The logger to use for logging publish activity. This can be null.sessionContext - The session context. This can be null
TransportException - If an error occurs initializing the transport.
public RequesterTransportInterface getRequesterTransport(com.sas.iom.SAS.IWorkspace workspace,
java.lang.String transportInformation,
java.lang.String[][] properties,
SessionContextInterface sessionContext)
throws TransportException
The following is excerpted from the doc for IOM's BrowseResultPackage which is used by this method:
The result package may be identified by physical path and filename, excluding any extension, or it may be an LDAP URL that contains the distinguished name of the sasArchive entry. If the LDAP server is secure, the LDAP URL may contain the bind distinguished name and password as shown in the document LDAP Channel Store Syntax. Or, "BINDDN" and "PASSWORD" may be specified as properties via the third (properties) parameter.
Session-based applications can specify a session context. The logger contained within the session context will be used by the publishing services to log publishing activity. Additionally, when a result package is retrieved, the requester transport will track the retrieved result package in the specified session context. If the session context is destroyed, the result package will be closed and resources will be freed. When a session context is specified, it is important for the calling application to close the result package when it is done using it. If the result package is not closed, it will remain in the session context and garbage collection will not occur until the session context is destroyed. The result package should be closed to ensure that it is removed from the session context.
workspace - the IWorkspace which provides the connectiontransportInformation - transport informationproperties - if needed by the transport; null otherwise.sessionContext - The session context. This can be null
TransportException - If an error occurs initializing the transport.
public ChannelTransportInterface getChannelTransport(ChannelInterface channel,
LoggerInterface logger,
SessionContextInterface sessionContext)
throws TransportException
getChannelTransport(ChannelInterface, SessionContextInterface)
Session-based applications can specify a session context. The user context contained within the session context will be used to obtain the credentials that will be used when publishing the content to any WebDAV location.
By default, the publish services will not provide any logging. The publish services will
utilize logging only if a session context or a logger is specified. If a logger is specified,
it will take precedence and will be used for logging publish activities. If a session context
is specified but the logger is null, the logger contained within the session
context will be used for logging purposes.
channel - The channel to publish to.logger - The logger to use for logging publish activity. This can be null.sessionContext - The session context.
TransportException - If an error occurs initializing the transport.
public ChannelTransportInterface getChannelTransport(ChannelInterface channel,
SessionContextInterface sessionContext)
throws TransportException
Session-based applications can specify a session context. The user context contained within the session context will be used to obtain the credentials that will be used when publishing the content to any WebDAV location.
channel - The channel to publish to.sessionContext - The session context.
TransportException - If an error occurs initializing the transport.
|
| Foundation |
|
| |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||||
