public interface InstallationProxyManager extends OsidProxyManager, InstallationProfile
The installation manager provides access to package installation
sessions and provides interoperability tests for various aspects of this
service. Methods in this manager accept a Proxy
for passing
information from server environments. The sessions included in this
manager are:
InstallationLookupSession:
a session to look up
local installations InstallationQuerySession:
a session to query local
installations
InstallationSearchSession:
a session to search
local installations InstallationManagementSession:
a session to
install and remove packages
InstallationUpdateSession:
a session to get
package updates InstallationNotificationSession
a session for
subscribing to new or deleted installations SiteLookupSession:
a session for listing
installation sites PackageLookupSession:
a session to look up
packages
PackageQuerySession:
a session to query packages
PackageSearchSession:
a session to search packages
PackageAdminSession:
a session to create, modify
and delete packages
PackageNotificationSession: a
session to receive
messages pertaining to package
changes PackageDepotSession:
a session for retrieving
package and depot mappings PackageDepotAssignmentSession:
a session for
managing package and depot mappings PackageSmartDepotSession:
a session for managing
smart depots of packages DepotLookupSession:
a session to lookup depots
DepotQuerySession:
a session to query depots DepotSearchSession
: a session to search depots
DepotAdminSession
: a session to create, modify
and delete depots DepotNotificationSession
: a session to receive
messages pertaining to depot changes DepotHierarchySession:
a session to traverse the
depot hierarchy DepotHierarchyDesignSession:
a session to manage
the depot hierarchy Modifier and Type | Method and Description |
---|---|
DepotAdminSession |
getDepotAdminSession(Proxy proxy)
Gets the OsidSession associated with the depot administration service.
|
DepotHierarchyDesignSession |
getDepotHierarchyDesignSession(Proxy proxy)
Gets the session designing depot hierarchies.
|
DepotHierarchySession |
getDepotHierarchySession(Proxy proxy)
Gets the session traversing depot hierarchies.
|
DepotLookupSession |
getDepotLookupSession(Proxy proxy)
Gets the OsidSession associated with the depot lookup service.
|
DepotNotificationSession |
getDepotNotificationSession(DepotReceiver depotReceiver,
Proxy proxy)
Gets the notification session for notifications pertaining to depot
service changes.
|
DepotQuerySession |
getDepotQuerySession(Proxy proxy)
Gets the depot query session.
|
DepotSearchSession |
getDepotSearchSession(Proxy proxy)
Gets the OsidSession associated with the depot search service.
|
InstallationBatchProxyManager |
getInstallationBatchProxyManager()
Gets an
InstallationBatchProxyManager. |
InstallationLookupSession |
getInstallationLookupSession(Proxy proxy)
Gets the
OsidSession associated with the installation
lookup service. |
InstallationLookupSession |
getInstallationLookupSessionForSite(Id siteId,
Proxy proxy)
Gets the
OsidSession associated with the installation
lookup service for the given site. |
InstallationManagementSession |
getInstallationManagementSession(Proxy proxy)
Gets the
OsidSession associated with the installation
management service. |
InstallationManagementSession |
getInstallationManagementSessionForSite(Id siteId,
Proxy proxy)
Gets the
OsidSession associated with the installation
management service for the given site. |
InstallationNotificationSession |
getInstallationNotificationSession(InstallationReceiver installationReceiver,
Proxy proxy)
Gets the notification session for notifications pertaining to
installation changes.
|
InstallationNotificationSession |
getInstallationNotificationSessionForSite(InstallationReceiver installationReceiver,
Id siteId,
Proxy proxy)
Gets the
OsidSession associated with the installation
notification service for the given site. |
InstallationQuerySession[] |
getInstallationQuerySession(Proxy proxy)
Gets the
OsidSession associated with the installation
query service. |
InstallationQuerySession[] |
getInstallationQuerySessionForSite(Id siteId,
Proxy proxy)
Gets the
OsidSession associated with the installation
query service for the given site. |
InstallationSearchSession |
getInstallationSearchSession(Proxy proxy)
Gets the
OsidSession associated with the installation
search service. |
InstallationSearchSession |
getInstallationSearchSessionForSite(Id siteId,
Proxy proxy)
Gets the
OsidSession associated with the installation
search service for the given site. |
InstallationUpdateSession |
getInstallationUpdateSession(Proxy proxy)
Gets the
OsidSession associated with the installation
update service. |
InstallationUpdateSession |
getInstallationUpdateSessionForSite(Id siteId,
Proxy proxy)
Gets the
OsidSession associated with the installation
update service for the given site. |
PackageAdminSession |
getPackageAdminSession(Proxy proxy)
Gets the
OsidSession associated with the package
administration service. |
PackageAdminSession |
getPackageAdminSessionForDepot(Id depotId,
Proxy proxy)
Gets the
OsidSession associated with the package admin
service for the given depot. |
PackageDepotSession |
getPackageDepotAssignmentSession(Proxy proxy)
Gets the session for assigning package to depot mappings.
|
PackageDepotSession |
getPackageDepotSession(Proxy proxy)
Gets the session for retrieving package to depot mappings.
|
PackageLookupSession |
getPackageLookupSession(Proxy proxy)
Gets the
OsidSession associated with the package lookup
service. |
PackageLookupSession |
getPackageLookupSessionForDepot(Id depotId,
Proxy proxy)
Gets the
OsidSession associated with the package lookup
service for the given depot. |
PackageNotificationSession |
getPackageNotificationSession(PackageReceiver packageReceiver,
Proxy proxy)
Gets the notification session for notifications pertaining to package
changes.
|
PackageNotificationSession |
getPackageNotificationSessionForDepot(PackageReceiver packageReceiver,
Id depotId,
Proxy proxy)
Gets the
OsidSession associated with the package
notification service for the given depot. |
PackageQuerySession |
getPackageQuerySession(Proxy proxy)
Gets the
OsidSession associated with the package query
service. |
PackageQuerySession |
getPackageQuerySessionForDepot(Id depotId,
Proxy proxy)
Gets the
OsidSession associated with the package query
service for the given depot. |
PackageSearchSession |
getPackageSearchSession(Proxy proxy)
Gets the
OsidSession associated with the package search
service. |
PackageSearchSession |
getPackageSearchSessionForDepot(Id depotId,
Proxy proxy)
Gets the
OsidSession associated with the package search
service for the given depot. |
PackageSmartDepotSession |
getPackageSmartDepotSession(Id depotId,
Proxy proxy)
Gets the session for managing dynamic package depot.
|
SiteLookupSession |
getSiteLookupSession(Proxy proxy)
Gets the
OsidSession associated with the site lookup
service. |
changeBranch, initialize, rollbackService
close
getDepotRecordTypes, getDepotSearchRecordTypes, getInstallationContentRecordTypes, getInstallationRecordTypes, getInstallationSearchRecordTypes, getPackageRecordTypes, getPackageSearchRecordTypes, getSiteRecordTypes, supportsDepotAdmin, supportsDepotHierarchy, supportsDepotHierarchyDesign, supportsDepotLookup, supportsDepotNotification, supportsDepotQuery, supportsDepotRecordType, supportsDepotSearch, supportsDepotSearchRecordType, supportsInstallationBatch, supportsInstallationContentRecordType, supportsInstallationLookup, supportsInstallationManagement, supportsInstallationNotification, supportsInstallationQuery, supportsInstallationRecordType, supportsInstallationSearch, supportsInstallationSearchRecordType, supportsInstallationUpdate, supportsPackageAdmin, supportsPackageDepot, supportsPackageDepotAssignment, supportsPackageLookup, supportsPackageNotification, supportsPackageQuery, supportsPackageRecordType, supportsPackageSearch, supportsPackageSearchRecordType, supportsPackageSmartDepot, supportsSiteLookup, supportsSiteRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
InstallationLookupSession getInstallationLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the installation
lookup service.proxy
- a proxy InstallationLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationLookup()
is false
optional
- This method must be implemented if
supportsInstallationLookup()
is true.
InstallationLookupSession getInstallationLookupSessionForSite(Id siteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
lookup service for the given site.siteId
- the Id
of the siteproxy
- a proxy an InstallationLookupSession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsInstallationLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstallationLookup()
and
supportsVisibleFederation()
are true.
InstallationQuerySession[] getInstallationQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the installation
query service.proxy
- a proxy InstallationQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationQuery()
is false
optional
- This method must be implemented if
supportsInstallationQuery()
is true.
InstallationQuerySession[] getInstallationQuerySessionForSite(Id siteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
query service for the given site.siteId
- the Id
of the siteproxy
- a proxy an InstallationQuerySession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsInstallationQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstallationQuery()
and
supportsVisibleFederation()
are true.
InstallationSearchSession getInstallationSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the installation
search service.proxy
- a proxy InstallationSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationSearch()
is false
optional
- This method must be implemented if
supportsInstallationSearch()
is true.
InstallationSearchSession getInstallationSearchSessionForSite(Id siteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
search service for the given site.siteId
- the Id
of the siteproxy
- a proxy an InstallationSearchSession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsInstallationSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstallationSearch()
and
supportsVisibleFederation()
are true.
InstallationManagementSession getInstallationManagementSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the installation
management service.proxy
- a proxy InstallationAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationManagement()
is false
optional
- This method must be implemented if
supportsInstallationManagement()
is true.
InstallationManagementSession getInstallationManagementSessionForSite(Id siteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
management service for the given site.siteId
- the Id
of the siteproxy
- a proxy an InstallationAdminSession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsInstallationManagement()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstallationManagement()
and
supportsVisibleFederation()
are true.
InstallationUpdateSession getInstallationUpdateSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the installation
update service.proxy
- a proxy InstallationAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationUpdate()
is false
optional
- This method must be implemented if
supportsInstallationUpdate()
is true.
InstallationUpdateSession getInstallationUpdateSessionForSite(Id siteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
update service for the given site.siteId
- the Id
of the siteproxy
- a proxy an InstallationUpdateSession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsInstallationUpdate()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstallationUpdate()
and
supportsVisibleFederation()
are true.
InstallationNotificationSession getInstallationNotificationSession(InstallationReceiver installationReceiver, Proxy proxy) throws OperationFailedException
installationReceiver
- the installation receiverproxy
- a proxy InstallationNotificationSession
NullArgumentException
- installationReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationNotification()
is false
optional
- This method must be implemented if
supportsInstallationNotification()
is true.
InstallationNotificationSession getInstallationNotificationSessionForSite(InstallationReceiver installationReceiver, Id siteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
notification service for the given site.installationReceiver
- the installation receiversiteId
- the Id
of the siteproxy
- a proxy an InstallationNotificationSession
NotFoundException
- siteId
not foundNullArgumentException
- installationReceiver,
siteId
or proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsInstallationNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstallationNotification()
and
supportsVisibleFederation()
are true.
SiteLookupSession getSiteLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the site lookup
service.proxy
- a proxy SiteLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSiteLookup()
is false
optional
- This method must be implemented if
supportsSiteLookup()
is true.
PackageLookupSession getPackageLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the package lookup
service.proxy
- a proxy PackageLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageLookup()
is false
optional
- This method must be implemented if
supportsPackageLookup()
is true.
PackageLookupSession getPackageLookupSessionForDepot(Id depotId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the package lookup
service for the given depot.depotId
- the Id
of the depotproxy
- a proxy a PackageLookupSession
NotFoundException
- depotId
not foundNullArgumentException
- depotId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsPackageLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPackageLookup()
and
supportsVisibleFederation()
are true.
PackageQuerySession getPackageQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the package query
service.proxy
- a proxy PackageQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageQuery()
is false
optional
- This method must be implemented if
supportsPackageQuery()
is true.
PackageQuerySession getPackageQuerySessionForDepot(Id depotId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the package query
service for the given depot.depotId
- the Id
of the Depot
proxy
- a proxy PackageQuerySession
NotFoundException
- no Depot
found by
the given Id
NullArgumentException
- depotId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPackageQuery()
and
supportsVisibleFederation()
are true
PackageSearchSession getPackageSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the package search
service.proxy
- a proxy PackageSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageSearch()
is false
optional
- This method must be implemented if
supportsPackageSearch()
is true.
PackageSearchSession getPackageSearchSessionForDepot(Id depotId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the package search
service for the given depot.depotId
- the Id
of the depotproxy
- a proxy a PackageSearchSession
NotFoundException
- depotId
not foundNullArgumentException
- depotId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsPackageSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPackageSearch()
and
supportsVisibleFederation()
are true.
PackageAdminSession getPackageAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the package
administration service.proxy
- a proxy PackageAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageAdmin()
is false
optional
- This method must be implemented if
supportsPackageAdmin()
is true.
PackageAdminSession getPackageAdminSessionForDepot(Id depotId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the package admin
service for the given depot.depotId
- the Id
of the depotproxy
- a proxy a PackageAdminSession
NotFoundException
- depotId
not foundNullArgumentException
- depotId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsPackageAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPackageAdmin()
and
supportsVisibleFederation()
are true.
PackageNotificationSession getPackageNotificationSession(PackageReceiver packageReceiver, Proxy proxy) throws OperationFailedException
packageReceiver
- the package receiverproxy
- a proxy PackageNotificationSession
NullArgumentException
- packageReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPackageNotification()
is false
optional
- This method must be implemented if
supportsPackageNotification()
is true.
PackageNotificationSession getPackageNotificationSessionForDepot(PackageReceiver packageReceiver, Id depotId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the package
notification service for the given depot.packageReceiver
- the package receiverdepotId
- the Id
of the depotproxy
- a proxy a PackageNotificationSession
NotFoundException
- depotId
not foundNullArgumentException
- packageReceiver, depotId
or proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsPackageNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPackageNotification()
and
supportsVisibleFederation()
are true.
PackageDepotSession getPackageDepotSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy PackageDepotSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageDepot()
is false
optional
- This method must be implemented if
supportsPackageDepot()
is true.
PackageDepotSession getPackageDepotAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy PackageDepotAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPackageDepotAssignment()
is false
optional
- This method must be implemented if
supportsPackageDepotAssignment()
is true.
PackageSmartDepotSession getPackageSmartDepotSession(Id depotId, Proxy proxy) throws NotFoundException, OperationFailedException
depotId
- the Id
of the depotproxy
- a proxy PackageSmartDepotSession
NotFoundException
- depotId
not foundNullArgumentException
- depotId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPackageSmartDepot()
is false
optional
- This method must be implemented if
supportsPackageSmartDepot()
is true.
DepotLookupSession getDepotLookupSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DepotLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDepotLookup()
is false
optional
- This method must be implemented if
supportsDepotLookup()
is true. DepotQuerySession getDepotQuerySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DepotQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDepotQuery()
is false
optional
- This method must be implemented if
supportsDepotQuery()
is true.
DepotSearchSession getDepotSearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DepotSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDepotSearch()
is false
optional
- This method must be implemented if
supportsDepotSearch()
is true. DepotAdminSession getDepotAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DepotAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDepotAdmin() is
false
optional
- This method must be implemented if
supportsDepotAdmin()
is true. DepotNotificationSession getDepotNotificationSession(DepotReceiver depotReceiver, Proxy proxy) throws OperationFailedException
depotReceiver
- the depot receiverproxy
- a proxy DepotNotificationSession
NullArgumentException
- depotReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDepotNotification() is false
optional
- This method must be implemented if
supportsDepotNotification()
is true. DepotHierarchySession getDepotHierarchySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DepotHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDepotHierarchy() is false
optional
- This method must be implemented if
supportsDepotHierarchy()
is true. DepotHierarchyDesignSession getDepotHierarchyDesignSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DepotHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDepotHierarchyDesign() is false
optional
- This method must be implemented if
supportsDepotHierarchyDesign()
is true. InstallationBatchProxyManager getInstallationBatchProxyManager() throws OperationFailedException
InstallationBatchProxyManager.
InstallationBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationBatch() is false
optional
- This method must be implemented if
supportsInstallationBatch()
is true.