public interface PackageManager
PackageManager
interface is the main interface
of the packagepool service.
To get this interface use:
PackageManager packageManager = (PackageManager) context.getConnection().getService(PackageManager.SERVICE_NAME);
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
ContentPackage |
createContentPackage(String name,
Project project)
Creates a new content package with the given name and the
given project as master project.
|
PublishGroup |
createPublishGroup(String name,
String description)
Creates a new publish group with the given name
and the given description.
|
TemplatePackage |
createTemplatePackage(String name,
Project project)
Creates a new template package with the given name and the
given project as master project.
|
Collection<String> |
getAvailableCustomScriptNames()
Deprecated.
since 5.0.39 - no replacement
|
PublishGroup |
getDefaultPublishGroup()
Returns the default publish group.
|
List<PackageVersionLogfile> |
getLogFiles(PackageVersion version)
Returns a list of
package version log files created during package version create of the package version specified by the given package version . |
List<PackageImportLogfile> |
getLogfiles(Subscription subscription)
Returns a list of all
import logfiles existing
for the given subscription. |
Package |
getPackageByName(String packageName)
Returns the
Package specified by the given
name or null if no package exists with the
given name. |
Collection<Package> |
getPackages()
Returns a read-only list of all
Package 's
existing on the server. |
Collection<Package> |
getPackages(int packageType)
Returns a read-only list of all existing
Package 's
of the given package type. |
Collection<Package> |
getPackages(Project masterProject)
Returns a read-only list of all existing
Package 's
for which the given project is master project |
Collection<PublishGroup> |
getPublishGroups()
Returns a read-only list of
PublishGroup 's
which are defined on this server. |
Subscription |
getSubscription(Package pck,
Project project)
Returns the subscription instance for the given package and project,
or
null if there is no subscription of this package in the provided project. |
Collection<Subscription> |
getSubscriptions()
Returns a read-only list of all
Subscription 's
existing on this server. |
Collection<Subscription> |
getSubscriptions(Filter<Subscription> filter)
Returns a read-only collection of all
Subscription 's
which matches the given filter. |
Collection<Subscription> |
getSubscriptions(Package pck)
Returns a read-only list of all
Subscription 's
which subscribe the given package. |
void |
refresh()
Refreshes this manager instance (e.g. reset caches).
|
void |
setDefaultPublishGroup(PublishGroup publishGroup)
Sets the default publish group.
|
static final String SERVICE_NAME
ContentPackage createContentPackage(String name, Project project)
name
- the name for the new packageproject
- the master project of the packageTemplatePackage createTemplatePackage(String name, Project project)
name
- the name for the new packageproject
- the master project of the packagePublishGroup createPublishGroup(String name, String description)
name
- the name for the new publish groupdescription
- the description for the new publish groupPublishGroup
the new publish groupCollection<PublishGroup> getPublishGroups()
PublishGroup
's
which are defined on this server.PublishGroup
'sPublishGroup getDefaultPublishGroup()
void setDefaultPublishGroup(PublishGroup publishGroup)
publishGroup
- the publish group to set as defaultCollection<Package> getPackages()
Package
's
existing on the server.Package
'sCollection<Package> getPackages(int packageType)
Package
's
of the given package type.packageType
- Package.CONTENT_PACKAGE
, Package.TEMPLATE_PACKAGE
Package
'sCollection<Package> getPackages(Project masterProject)
Package
's
for which the given project is master projectmasterProject
- Package
's@Nullable Package getPackageByName(String packageName)
Package
specified by the given
name or null
if no package exists with the
given name.packageName
- the name of the packagenull
Collection<Subscription> getSubscriptions()
Subscription
's
existing on this server.Subscription
's@Nullable Subscription getSubscription(Package pck, Project project)
null
if there is no subscription of this package in the provided project.null
if there is no subscription of this package in the provided project.Collection<Subscription> getSubscriptions(Package pck)
Subscription
's
which subscribe the given package.pck
- the package to get subscriptions forSubscription
'sCollection<Subscription> getSubscriptions(Filter<Subscription> filter)
Subscription
's
which matches the given filter.filter
- Filter to be passed. If null
, accepts all elements.@Deprecated Collection<String> getAvailableCustomScriptNames()
List<PackageImportLogfile> getLogfiles(Subscription subscription)
import logfiles
existing
for the given subscription.List<PackageVersionLogfile> getLogFiles(PackageVersion version)
package version log files
created during package version create of the package version
specified by the given package version
.number
.
Normally the returned list will only contain one entry. Only in case of errors during package version creation multiple log files were created.version
- the package version
to get the log files forvoid refresh()
Copyright © 2015 e-Spirit AG. All Rights Reserved. Build 5.1.408