public interface InstallationManager extends OsidManager, InstallationProfile
The installation manager provides access to package installation sessions and provides interoperability tests for various aspects of this service. 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()
Gets the OsidSession associated with the depot administration service.
|
DepotHierarchyDesignSession |
getDepotHierarchyDesignSession()
Gets the session designing depot hierarchies.
|
DepotHierarchySession |
getDepotHierarchySession()
Gets the session traversing depot hierarchies.
|
DepotLookupSession |
getDepotLookupSession()
Gets the OsidSession associated with the depot lookup service.
|
DepotNotificationSession |
getDepotNotificationSession(DepotReceiver depotReceiver)
Gets the notification session for notifications pertaining to depot
service changes.
|
DepotQuerySession |
getDepotQuerySession()
Gets the depot query session.
|
DepotSearchSession |
getDepotSearchSession()
Gets the OsidSession associated with the depot search service.
|
InstallationBatchManager |
getInstallationBatchManager()
Gets an
InstallationBatchManager. |
InstallationLookupSession |
getInstallationLookupSession()
Gets the
OsidSession associated with the installation
lookup service. |
InstallationLookupSession |
getInstallationLookupSessionForSite(Id siteId)
Gets the
OsidSession associated with the installation
lookup service for the given site. |
InstallationManagementSession |
getInstallationManagementSession()
Gets the
OsidSession associated with the installation
management service. |
InstallationManagementSession |
getInstallationManagementSessionForSite(Id siteId)
Gets the
OsidSession associated with the installation
management service for the given site. |
InstallationNotificationSession |
getInstallationNotificationSession(InstallationReceiver installationReceiver)
Gets the notification session for notifications pertaining to
installation changes.
|
InstallationNotificationSession |
getInstallationNotificationSessionForSite(InstallationReceiver installationReceiver,
Id siteId)
Gets the
OsidSession associated with the installation
notification service for the given site. |
InstallationQuerySession[] |
getInstallationQuerySession()
Gets the
OsidSession associated with the installation
query service. |
InstallationQuerySession[] |
getInstallationQuerySessionForSite(Id siteId)
Gets the
OsidSession associated with the installation
query service for the given site. |
InstallationSearchSession |
getInstallationSearchSession()
Gets the
OsidSession associated with the installation
search service. |
InstallationSearchSession |
getInstallationSearchSessionForSite(Id siteId)
Gets the
OsidSession associated with the installation
search service for the given site. |
InstallationUpdateSession |
getInstallationUpdateSession()
Gets the
OsidSession associated with the installation
update service. |
InstallationUpdateSession |
getInstallationUpdateSessionForSite(Id siteId)
Gets the
OsidSession associated with the installation
update service for the given site. |
PackageAdminSession |
getPackageAdminSession()
Gets the
OsidSession associated with the package
administration service. |
PackageAdminSession |
getPackageAdminSessionForDepot(Id depotId)
Gets the
OsidSession associated with the package admin
service for the given depot. |
PackageDepotSession |
getPackageDepotAssignmentSession()
Gets the session for assigning package to depot mappings.
|
PackageDepotSession |
getPackageDepotSession()
Gets the session for retrieving package to depot mappings.
|
PackageLookupSession |
getPackageLookupSession()
Gets the
OsidSession associated with the package lookup
service. |
PackageLookupSession |
getPackageLookupSessionForDepot(Id depotId)
Gets the
OsidSession associated with the package lookup
service for the given depot. |
PackageNotificationSession |
getPackageNotificationSession(PackageReceiver packageReceiver)
Gets the notification session for notifications pertaining to package
changes.
|
PackageNotificationSession |
getPackageNotificationSessionForDepot(PackageReceiver packageReceiver,
Id depotId)
Gets the
OsidSession associated with the package
notification service for the given depot. |
PackageQuerySession |
getPackageQuerySession()
Gets the
OsidSession associated with the package query
service. |
PackageQuerySession |
getPackageQuerySessionForDepot(Id depotId)
Gets the
OsidSession associated with the package query
service for the given depot. |
PackageSearchSession |
getPackageSearchSession()
Gets the
OsidSession associated with the package search
service. |
PackageSearchSession |
getPackageSearchSessionForDepot(Id depotId)
Gets the
OsidSession associated with the package search
service for the given depot. |
PackageSmartDepotSession |
getPackageSmartDepotSession(Id depotId)
Gets the session for managing dynamic package depot.
|
SiteLookupSession |
getSiteLookupSession()
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() throws OperationFailedException
OsidSession
associated with the installation
lookup service. InstallationLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationLookup()
is false
optional
- This method must be implemented if
supportsInstallationLookup()
is true.
InstallationLookupSession getInstallationLookupSessionForSite(Id siteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
lookup service for the given site.siteId
- the Id
of the site an InstallationLookupSession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
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() throws OperationFailedException
OsidSession
associated with the installation
query service. InstallationQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationQuery()
is false
optional
- This method must be implemented if
supportsInstallationQuery()
is true.
InstallationQuerySession[] getInstallationQuerySessionForSite(Id siteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
query service for the given site.siteId
- the Id
of the site an InstallationQuerySession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
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() throws OperationFailedException
OsidSession
associated with the installation
search service. InstallationSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationSearch()
is false
optional
- This method must be implemented if
supportsInstallationSearch()
is true.
InstallationSearchSession getInstallationSearchSessionForSite(Id siteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
search service for the given site.siteId
- the Id
of the site an InstallationSearchSession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
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() throws OperationFailedException
OsidSession
associated with the installation
management service. InstallationAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationManagement()
is false
optional
- This method must be implemented if
supportsInstallationManagement()
is true.
InstallationManagementSession getInstallationManagementSessionForSite(Id siteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
management service for the given site.siteId
- the Id
of the site an InstallationAdminSession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
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() throws OperationFailedException
OsidSession
associated with the installation
update service. InstallationAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationUpdate()
is false
optional
- This method must be implemented if
supportsInstallationUpdate()
is true.
InstallationUpdateSession getInstallationUpdateSessionForSite(Id siteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
update service for the given site.siteId
- the Id
of the site an InstallationUpdateSession
NotFoundException
- siteId
not foundNullArgumentException
- siteId
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) throws OperationFailedException
installationReceiver
- the installation receiver InstallationNotificationSession
NullArgumentException
- installationReceiver
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) throws NotFoundException, OperationFailedException
OsidSession
associated with the installation
notification service for the given site.installationReceiver
- the installation receiversiteId
- the Id
of the site an InstallationNotificationSession
NotFoundException
- siteId
not foundNullArgumentException
- installationReceiver
or siteId
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() throws OperationFailedException
OsidSession
associated with the site lookup
service. SiteLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSiteLookup()
is false
optional
- This method must be implemented if
supportsSiteLookup()
is true.
PackageLookupSession getPackageLookupSession() throws OperationFailedException
OsidSession
associated with the package lookup
service. PackageLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageLookup()
is false
optional
- This method must be implemented if
supportsPackageLookup()
is true.
PackageLookupSession getPackageLookupSessionForDepot(Id depotId) throws NotFoundException, OperationFailedException
OsidSession
associated with the package lookup
service for the given depot.depotId
- the Id
of the depot a PackageLookupSession
NotFoundException
- depotId
not foundNullArgumentException
- depotId
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() throws OperationFailedException
OsidSession
associated with the package query
service. PackageQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageQuery()
is false
optional
- This method must be implemented if
supportsPackageQuery()
is true.
PackageQuerySession getPackageQuerySessionForDepot(Id depotId) throws NotFoundException, OperationFailedException
OsidSession
associated with the package query
service for the given depot.depotId
- the Id
of the Depot
PackageQuerySession
NotFoundException
- no Depot
found by
the given Id
NullArgumentException
- depotId
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() throws OperationFailedException
OsidSession
associated with the package search
service. PackageSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageSearch()
is false
optional
- This method must be implemented if
supportsPackageSearch()
is true.
PackageSearchSession getPackageSearchSessionForDepot(Id depotId) throws NotFoundException, OperationFailedException
OsidSession
associated with the package search
service for the given depot.depotId
- the Id
of the depot a PackageSearchSession
NotFoundException
- depotId
not foundNullArgumentException
- depotId
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() throws OperationFailedException
OsidSession
associated with the package
administration service. PackageAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageAdmin()
is false
optional
- This method must be implemented if
supportsPackageAdmin()
is true.
PackageAdminSession getPackageAdminSessionForDepot(Id depotId) throws NotFoundException, OperationFailedException
OsidSession
associated with the package admin
service for the given depot.depotId
- the Id
of the depot a PackageAdminSession
NotFoundException
- depotId
not foundNullArgumentException
- depotId
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) throws OperationFailedException
packageReceiver
- the package receiver PackageNotificationSession
NullArgumentException
- packageReceiver
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) throws NotFoundException, OperationFailedException
OsidSession
associated with the package
notification service for the given depot.packageReceiver
- the package receiverdepotId
- the Id
of the depot a PackageNotificationSession
NotFoundException
- depotId
not foundNullArgumentException
- packageReceiver
or depotId
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() throws OperationFailedException
PackageDepotSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPackageDepot()
is false
optional
- This method must be implemented if
supportsPackageDepot()
is true.
PackageDepotSession getPackageDepotAssignmentSession() throws OperationFailedException
PackageDepotAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPackageDepotAssignment()
is false
optional
- This method must be implemented if
supportsPackageDepotAssignment()
is true.
PackageSmartDepotSession getPackageSmartDepotSession(Id depotId) throws NotFoundException, OperationFailedException
depotId
- the Id
of the depot PackageSmartDepotSession
NotFoundException
- depotId
not foundNullArgumentException
- depotId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPackageSmartDepot()
is false
optional
- This method must be implemented if
supportsPackageSmartDepot()
is true.
DepotLookupSession getDepotLookupSession() throws OperationFailedException
DepotLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDepotLookup()
is false
optional
- This method must be implemented if
supportsDepotLookup()
is true. DepotQuerySession getDepotQuerySession() throws OperationFailedException
DepotQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDepotQuery()
is false
optional
- This method must be implemented if
supportsDepotQuery()
is true.
DepotSearchSession getDepotSearchSession() throws OperationFailedException
DepotSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDepotSearch()
is false
optional
- This method must be implemented if
supportsDepotSearch()
is true. DepotAdminSession getDepotAdminSession() throws OperationFailedException
DepotAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDepotAdmin() is
false
optional
- This method must be implemented if
supportsDepotAdmin()
is true. DepotNotificationSession getDepotNotificationSession(DepotReceiver depotReceiver) throws OperationFailedException
depotReceiver
- the depot receiver DepotNotificationSession
NullArgumentException
- depotReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDepotNotification() is false
optional
- This method must be implemented if
supportsDepotNotification()
is true. DepotHierarchySession getDepotHierarchySession() throws OperationFailedException
DepotHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDepotHierarchy() is false
optional
- This method must be implemented if
supportsDepotHierarchy()
is true. DepotHierarchyDesignSession getDepotHierarchyDesignSession() throws OperationFailedException
DepotHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDepotHierarchyDesign() is false
optional
- This method must be implemented if
supportsDepotHierarchyDesign()
is true. InstallationBatchManager getInstallationBatchManager() throws OperationFailedException
InstallationBatchManager.
InstallationBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstallationBatch() is false
optional
- This method must be implemented if
supportsInstallationBatch()
is true.