com.trendmicro.grid.acl.l0
Interface PublicPackageService

All Superinterfaces:

Service

All Known Subinterfaces:

PackageService

@PublicRequestContext
@WebServlet(value="/ws/level-0/packages")
public interface PublicPackageService
extends Service

Defines package related web services, accessible to the outside world.

Version:

1.0

Author:

Juergen_Kellerer, 2010-04-23

Method Summary

NamedFileIdentifierListPage	getFilesContainedInPackageById(FileIdentifier packageFile, int pageNumber) Returns the ids of all files contained inside the given package.
NamedFileIdentifierListPage	getFilesContainedInPackageByName(String packageName, int pageNumber) Returns the ids of all files contained inside the given package.
NameListPage	getMatchingPackageNames(String tagExpression, String tagExpressionVersion, int pageNumber) Returns all known packages that are matched by the given tag expression.
NameListPage	getMatchingPackageNamesInRange(String tagExpression, String tagExpressionVersion, Range range, int pageNumber) Returns all known packages that are matched by the given tag expression and are in the given range.
PackageDetails	getPackageDetailsById(FileIdentifier file) Returns the package details on the given package file id.
PackageDetails	getPackageDetailsByName(String packageName) Returns the package details on the given package name.
Collection<PackageDetails>	getPackageDetailsListById(BatchCollection<FileIdentifier> files) Returns the package details on the given package file ids.
Collection<PackageDetails>	getPackageDetailsListByName(BatchCollection<String> packageNames) Returns the package details on the given package names.
Collection<String>	getPackageDisplayNames(BatchCollection<String> packageNames) Returns the displaynames for the given reference names.
PackageFamily	getPackageFamily(String basename) Returns the package family on the given basename.
Collection<String>	getPackageFamilyDisplayNames(BatchCollection<String> packageFamilyNames) Returns the displaynames for the given reference names.
NameListPage	getPackageFamilyNames(int pageNumber) Returns all known package family names.
NameListPage	getPackageFamilyNamesForVendor(String vendorName, int pageNumber) Returns all known package family names for the given vendor.
Collection<FileIdentifier>	getPackageFileIdentifiersByName(BatchCollection<String> packageNames) Returns the file ID of the file that is associated with the given package.
PackageInformation	getPackageInformationById(FileIdentifier file) Returns the package information of the given package.
PackageInformation	getPackageInformationByName(String packageName) Returns the package information of the given package.
Collection<PackageInformation>	getPackageInformationListById(BatchCollection<FileIdentifier> files) Returns the package information list of the given packages.
Collection<PackageInformation>	getPackageInformationListByName(BatchCollection<String> packageNames) Returns the package information list of the given packages.
NameListPage	getPackageNamesInFamily(String packageFamilyName, int pageNumber) Returns all package names that are members of the given package family.
NameListPage	getPackageNamesTaggedWith(String[] tags, int pageNumber) Returns all known package names that are tagged with the given list of tags.
NameListPage	getPackagesContainedInPackageById(FileIdentifier packageFile, int pageNumber) Returns the names of all packages contained inside the given package.
NameListPage	getPackagesContainedInPackageByName(String packageName, int pageNumber) Returns the names of all packages contained inside the given package.
NameListPage	getReferencingPackageNames(String packageName, int pageNumber) Returns the names of all packages that reference the given package directly.
NameListPage	getReferencingPackageNamesById(FileIdentifier file, int pageNumber) Returns the names of all packages that reference the given file directly.
Vendor	getVendor(String name) Returns the vendor information for the given vendor name.
Collection<String>	getVendorDisplayNames(BatchCollection<String> vendorNames) Returns the displaynames for the given reference names.
NameListPage	getVendorNames(int pageNumber) Returns all known vendor names.
Collection<IsTrueResult>	isPackagesTaggedWithAllById(BatchCollection<FileIdentifier> files, String[] tags) Returns 'Yes' if the given packages are tagged with the specified tags.
Collection<IsTrueResult>	isPackagesTaggedWithAllByName(BatchCollection<String> packageNames, String[] tags) Returns 'Yes' if the given packages are tagged with the specified tags.
Collection<Boolean>	isPackagesTaggedWithById(BatchCollection<FileIdentifier> files, String[] tags) Deprecated. Please use isPackagesTaggedWithAllById(BatchCollection, String[]) instead.
Collection<Boolean>	isPackagesTaggedWithByName(BatchCollection<String> packageNames, String[] tags) Deprecated. Please use isPackagesTaggedWithAllByName(BatchCollection, String[]) instead.
IsTrueResult	isPackageTaggedWithAllById(FileIdentifier file, String[] tags) Returns 'Yes' if the given package is tagged with the specified tags.
IsTrueResult	isPackageTaggedWithAllByName(String packageName, String[] tags) Returns 'Yes' if the given package is tagged with the specified tags.
Boolean	isPackageTaggedWithById(FileIdentifier file, String[] tags) Deprecated. Please use isPackageTaggedWithAllById(FileIdentifier, String[]) instead.
Boolean	isPackageTaggedWithByName(String packageName, String[] tags) Deprecated. Please use isPackageTaggedWithAllByName(String, String[]) instead.

Method Detail

getVendorNames

@RequiredRoles(value="run.package.queries")
NameListPage getVendorNames(int pageNumber)
                            throws AuthenticationException

Returns all known vendor names.

Parameters:

pageNumber - The number of the list page to return, starting from 0 for the first chunk.

Returns:

A page of known vendor names or 'null' if no page exists under the given number.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getVendorDisplayNames

@RequiredRoles(value="run.package.queries")
Collection<String> getVendorDisplayNames(BatchCollection<String> vendorNames)
                                         throws AuthenticationException

Returns the displaynames for the given reference names.

Parameters:

vendorNames - the names of the vendors to return the display names for.

Returns:

a collection of displaynames for the given names, never 'null'.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageFamilyNames

@RequiredRoles(value="run.package.queries")
NameListPage getPackageFamilyNames(int pageNumber)
                                   throws AuthenticationException

Returns all known package family names.

Parameters:

pageNumber - The number of the list page to return, starting from 0 for the first chunk.

Returns:

A page of known package family names or 'null' if no page exists under the given number.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageFamilyDisplayNames

@RequiredRoles(value="run.package.queries")
Collection<String> getPackageFamilyDisplayNames(BatchCollection<String> packageFamilyNames)
                                                throws AuthenticationException

Returns the displaynames for the given reference names.

Parameters:

packageFamilyNames - the names of the package families to return the display names for.

Returns:

a collection of displaynames for the given names, never 'null'.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageFamilyNamesForVendor

@RequiredRoles(value="run.package.queries")
NameListPage getPackageFamilyNamesForVendor(String vendorName,
                                                               int pageNumber)
                                            throws AuthenticationException

Returns all known package family names for the given vendor.

Parameters:

vendorName - the name of the vendor to query package families from.

pageNumber - The number of the list page to return, starting from 0 for the first chunk.

Returns:

A page of known package family names or 'null' if no page exists under the given number.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageNamesInFamily

@RequiredRoles(value="run.package.queries")
NameListPage getPackageNamesInFamily(String packageFamilyName,
                                                        int pageNumber)
                                     throws AuthenticationException

Returns all package names that are members of the given package family.

Parameters:

packageFamilyName - the name of the package family to query package names from.

pageNumber - The number of the list page to return, starting from 0 for the first chunk.

Returns:

A page of package names or 'null' if no page exists under the given number.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageDisplayNames

@RequiredRoles(value="run.package.queries")
Collection<String> getPackageDisplayNames(BatchCollection<String> packageNames)
                                          throws AuthenticationException

Returns the displaynames for the given reference names.

Parameters:

packageNames - the names of the packages to return the display names for.

Returns:

a collection of displaynames for the given names, never 'null'.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

isPackageTaggedWithById

@Deprecated
@RequiredRoles(value="run.package.queries")
Boolean isPackageTaggedWithById(FileIdentifier file,
                                                              String[] tags)
                                throws AuthenticationException

Deprecated. Please use isPackageTaggedWithAllById(FileIdentifier, String[]) instead.

Returns true if the given package is tagged with the specified tags.

Parameters:

file - The package file to verify.

tags - The tags to check against.

Returns:

True if the tags apply to the package, false if not, 'null' if the package is unknown or the file id references a ordinary file not a package.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

isPackagesTaggedWithById

@Deprecated
@RequiredRoles(value="run.package.queries")
Collection<Boolean> isPackagesTaggedWithById(BatchCollection<FileIdentifier> files,
                                                                           String[] tags)
                                             throws AuthenticationException

Deprecated. Please use isPackagesTaggedWithAllById(BatchCollection, String[]) instead.

Returns true if the given packages are tagged with the specified tags.

Implements a batch query for isPackageTaggedWithById(FileIdentifier, String[]).

Important Note: This method returned incorrect data when 'null' values were contained in the result. 'Null' values are swallowed by the XML serialization framework, because it considers the booleans as primitive types. Therefore starting from GACL 1.2, this method substitutes 'null' with 'false'. Use isPackagesTaggedWithAllById(BatchCollection, String[]) instead, to get a 3-way result.

Parameters:

files - The package files to verify.

tags - The tags to check against.

Returns:

True if the tags apply to the package, false if not.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

isPackageTaggedWithAllById

@RequiredRoles(value="run.package.queries")
IsTrueResult isPackageTaggedWithAllById(FileIdentifier file,
                                                           String[] tags)
                                        throws AuthenticationException

Returns 'Yes' if the given package is tagged with the specified tags.

When querying multiple packages, isPackagesTaggedWithAllById(BatchCollection, String[]), may be more efficient.

Note: This method is a replacement for isPackageTaggedWithById(FileIdentifier, String[]) as a 3-way boolean is not obvious and not supported in all programming languages.

Parameters:

file - The package file to verify.

tags - The tags to check against.

Returns:

'Yes' if the tags apply to the package, 'No' if not, 'NotKnown' if the package is unknown or the file id references a ordinary file not a package.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

See Also:

isPackageTaggedWithAllByName(String, String[])

isPackagesTaggedWithAllById

@RequiredRoles(value="run.package.queries")
Collection<IsTrueResult> isPackagesTaggedWithAllById(BatchCollection<FileIdentifier> files,
                                                                        String[] tags)
                                                     throws AuthenticationException

Returns 'Yes' if the given packages are tagged with the specified tags.

Implements a batch query for isPackageTaggedWithAllById(FileIdentifier, String[]).

Note: This method is a replacement for isPackagesTaggedWithById(BatchCollection, String[]) as a 3-way boolean is not obvious and not supported in all programming languages.

Parameters:

files - The package files to verify.

tags - The tags to check against.

Returns:

'Yes' if the tags apply to the package, 'No' if not, 'NotKnown' if the package is unknown or the file id references a ordinary file not a package.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

See Also:

isPackagesTaggedWithAllByName(BatchCollection, String[])

isPackageTaggedWithByName

@Deprecated
@RequiredRoles(value="run.package.queries")
Boolean isPackageTaggedWithByName(String packageName,
                                                                String[] tags)
                                  throws AuthenticationException

Deprecated. Please use isPackageTaggedWithAllByName(String, String[]) instead.

Returns true if the given package is tagged with the specified tags.

Parameters:

packageName - The package to verify.

tags - The tags to check against.

Returns:

True if the tags apply to the package, false if not, 'null' if the package is unknown.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

isPackagesTaggedWithByName

@Deprecated
@RequiredRoles(value="run.package.queries")
Collection<Boolean> isPackagesTaggedWithByName(BatchCollection<String> packageNames,
                                                                             String[] tags)
                                               throws AuthenticationException

Deprecated. Please use isPackagesTaggedWithAllByName(BatchCollection, String[]) instead.

Returns true if the given packages are tagged with the specified tags.

Implements a batch query for isPackageTaggedWithByName(String, String[]).

Important Note: This method returned incorrect data when 'null' values were contained in the result. 'Null' values are swallowed by the XML serialization framework, because it considers the booleans as primitive types. Therefore starting from GACL 1.2, this method substitutes 'null' with 'false'. Use isPackagesTaggedWithAllByName(BatchCollection, String[]) instead, to get a 3-way result.

Parameters:

packageNames - The package to verify.

tags - The tags to check against.

Returns:

True if the tags apply to the package, false if not.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

isPackageTaggedWithAllByName

@RequiredRoles(value="run.package.queries")
IsTrueResult isPackageTaggedWithAllByName(String packageName,
                                                             String[] tags)
                                          throws AuthenticationException

Returns 'Yes' if the given package is tagged with the specified tags.

When querying multiple packages, isPackagesTaggedWithAllByName(BatchCollection, String[]), may be more efficient.

Note: This method is a replacement for isPackageTaggedWithByName(String, String[]) as a 3-way boolean is not obvious and not supported in all programming languages.

Parameters:

packageName - The package to verify.

tags - The tags to check against.

Returns:

'Yes' if the tags apply to the package, 'No' if not, 'NotKnown' if the package is unknown.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

See Also:

isPackageTaggedWithAllById(com.trendmicro.grid.acl.l0.datatypes.FileIdentifier, String[])

isPackagesTaggedWithAllByName

@RequiredRoles(value="run.package.queries")
Collection<IsTrueResult> isPackagesTaggedWithAllByName(BatchCollection<String> packageNames,
                                                                          String[] tags)
                                                       throws AuthenticationException

Returns 'Yes' if the given packages are tagged with the specified tags.

Implements a batch query for isPackageTaggedWithAllByName(String, String[]).

Note: This method is a replacement for isPackagesTaggedWithByName(BatchCollection, String[]) as a 3-way boolean is not obvious and not supported in all programming languages.

Parameters:

packageNames - The package to verify.

tags - The tags to check against.

Returns:

'Yes' if the tags apply to the package, 'No' if not, 'NotKnown' if the package is unknown.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

See Also:

isPackagesTaggedWithAllById(BatchCollection, String[])

getPackageNamesTaggedWith

@PublicRequestContext(value="tag-matching-query")
@RequiredRoles(value={"run.package.queries","run.tag.matching.queries"})
NameListPage getPackageNamesTaggedWith(String[] tags,
                                                                                    int pageNumber)
                                       throws AuthenticationException

Returns all known package names that are tagged with the given list of tags.

Parameters:

tags - The tags to get the files for.

pageNumber - The number of the list page to return, starting from 0 for the first chunk.

Returns:

A page of package names for the packages tagged with the given tags or 'null' if no page exists under the given number.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getMatchingPackageNames

@PublicRequestContext(value="tag-matching-query")
@RequiredRoles(value={"run.package.queries","run.tag.matching.queries"})
NameListPage getMatchingPackageNames(String tagExpression,
                                                                                  String tagExpressionVersion,
                                                                                  int pageNumber)
                                     throws AuthenticationException

Returns all known packages that are matched by the given tag expression.

Tag Query Grammar
A common tag query uses a simple search gramar also common for most search engines:

• Tags are delimted by whitespaces
• Adding "-" in front of a tag negates the search (the tag must not be included in results)
• Groups can be built by adding braces arround tags. Multiple groups are combined with OR (the same as if multiple individual queries would be combined).
• Tags in one group are combined with AND (all have to be included (or excluded when prefixed with "-"))

Example query: (mustbe1Group1 -mustnotbe1Group1) (mustbe1Group2 -mustnotbe1Group2 mustbe2Group2)

Parameters:

tagExpression - An expression following the tag query grammar used to identify packages.

tagExpressionVersion - The version of the expression (the most recent version is assumed if ommitted).

pageNumber - The number of the list page to return, starting from 0 for the first chunk.

Returns:

A page of package names for the packages, matching the given expression or 'null' if no page exists under the given number.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getMatchingPackageNamesInRange

@PublicRequestContext(value="tag-matching-query")
@RequiredRoles(value={"run.package.queries","run.tag.matching.queries"})
NameListPage getMatchingPackageNamesInRange(String tagExpression,
                                                                                         String tagExpressionVersion,
                                                                                         Range range,
                                                                                         int pageNumber)
                                            throws AuthenticationException

Returns all known packages that are matched by the given tag expression and are in the given range.

Parameters:

tagExpression - An expression following the tag query grammar used to identify packages.

tagExpressionVersion - The version of the expression (the most recent version is assumed if ommitted).

range - The range limiting the output.

pageNumber - The number of the list page to return, starting from 0 for the first chunk.

Returns:

A page of package names for the packages, matching the given expression or 'null' if no page exists under the given number.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getReferencingPackageNamesById

@RequiredRoles(value={"run.package.queries","run.complex.queries"})
NameListPage getReferencingPackageNamesById(FileIdentifier file,
                                                               int pageNumber)
                                            throws AuthenticationException

Returns the names of all packages that reference the given file directly.

A package references a file if the file is a direct child of the package.

Parameters:

file - The file to return the referencing package names for.

pageNumber - The number of the list page to return, starting from 0 for the first page.

Returns:

A page of package names or 'null' if no page exists under the given number.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getReferencingPackageNames

@RequiredRoles(value={"run.package.queries","run.complex.queries"})
NameListPage getReferencingPackageNames(String packageName,
                                                           int pageNumber)
                                        throws AuthenticationException

Returns the names of all packages that reference the given package directly.

Parameters:

packageName - The package name to return the names of referencing packages.

pageNumber - The number of the list page to return, starting from 0 for the first page.

Returns:

A page of package names or 'null' if no page exists under the given name or pageNumber.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getFilesContainedInPackageById

@RequiredRoles(value={"run.package.queries","run.complex.queries"})
NamedFileIdentifierListPage getFilesContainedInPackageById(FileIdentifier packageFile,
                                                                              int pageNumber)
                                                           throws AuthenticationException

Returns the ids of all files contained inside the given package.

Parameters:

packageFile - The id of the package file to look for its children.

pageNumber - The number of the list page to return, starting from 0 for the first page.

Returns:

the ids of all files contained inside the given package.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getFilesContainedInPackageByName

@RequiredRoles(value={"run.package.queries","run.complex.queries"})
NamedFileIdentifierListPage getFilesContainedInPackageByName(String packageName,
                                                                                int pageNumber)
                                                             throws AuthenticationException

Returns the ids of all files contained inside the given package.

Parameters:

packageName - The name of the package to look for its children.

pageNumber - The number of the list page to return, starting from 0 for the first page.

Returns:

the ids of all files contained inside the given package.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackagesContainedInPackageById

@RequiredRoles(value={"run.package.queries","run.complex.queries"})
NameListPage getPackagesContainedInPackageById(FileIdentifier packageFile,
                                                                  int pageNumber)
                                               throws AuthenticationException

Returns the names of all packages contained inside the given package.

Parameters:

packageFile - The id of the package file to look for its children.

pageNumber - The number of the list page to return, starting from 0 for the first page.

Returns:

the names of all packages contained inside the given package.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackagesContainedInPackageByName

@RequiredRoles(value={"run.package.queries","run.complex.queries"})
NameListPage getPackagesContainedInPackageByName(String packageName,
                                                                    int pageNumber)
                                                 throws AuthenticationException

Returns the names of all packages contained inside the given package.

Parameters:

packageName - The name of the package to look for its children.

pageNumber - The number of the list page to return, starting from 0 for the first page.

Returns:

the names of all packages contained inside the given package.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageInformationById

@RequiredRoles(value="run.package.queries")
PackageInformation getPackageInformationById(FileIdentifier file)
                                             throws AuthenticationException

Returns the package information of the given package.

Parameters:

file - The id of the package file to look for.

Returns:

the package information of the given package or 'null' if no package exists under the specified arguments.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageInformationListById

@ResponseWrapper(className="com.trendmicro.grid.acl.l0.wrappers.GetPackageInformationListByIdResponse")
@RequiredRoles(value="run.package.queries")
Collection<PackageInformation> getPackageInformationListById(BatchCollection<FileIdentifier> files)
                                                             throws AuthenticationException

Returns the package information list of the given packages.

Parameters:

files - The ids of the package files to look for.

Returns:

the package information list of the given package or 'null' if no packages exists under the specified arguments.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageInformationByName

@RequiredRoles(value="run.package.queries")
PackageInformation getPackageInformationByName(String packageName)
                                               throws AuthenticationException

Returns the package information of the given package.

Parameters:

packageName - The name of the package to look for.

Returns:

the package information of the given package or 'null' if no package exists under the specified arguments.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageInformationListByName

@ResponseWrapper(className="com.trendmicro.grid.acl.l0.wrappers.GetPackageInformationListByNameResponse")
@RequiredRoles(value="run.package.queries")
Collection<PackageInformation> getPackageInformationListByName(BatchCollection<String> packageNames)
                                                               throws AuthenticationException

Returns the package information list of the given packages.

Parameters:

packageNames - The names of the packages to look for.

Returns:

the package information list of the given package or 'null' if no packages exists under the specified arguments.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageFileIdentifiersByName

@ResponseWrapper(className="com.trendmicro.grid.acl.l0.wrappers.GetPackageFileIdentifiersByNameResponse")
@RequiredRoles(value="run.package.queries")
Collection<FileIdentifier> getPackageFileIdentifiersByName(BatchCollection<String> packageNames)
                                                           throws AuthenticationException

Returns the file ID of the file that is associated with the given package.

Parameters:

packageNames - The names of the packages to look for.

Returns:

the the file ID of the file that is associated with the given package.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getVendor

@RequiredRoles(value={"run.package.queries","access.details"})
Vendor getVendor(String name)
                 throws AuthenticationException

Returns the vendor information for the given vendor name.

Parameters:

name - the name of the vendor to return.

Returns:

the vendor information for the given vendor name.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageFamily

@RequiredRoles(value={"run.package.queries","access.details"})
PackageFamily getPackageFamily(String basename)
                               throws AuthenticationException

Returns the package family on the given basename.

Parameters:

basename - the name of the package family.

Returns:

the package family on the given basename.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageDetailsById

@RequiredRoles(value={"run.package.queries","access.details"})
PackageDetails getPackageDetailsById(FileIdentifier file)
                                     throws AuthenticationException

Returns the package details on the given package file id.

Parameters:

file - The SHA1 hash of the package file.

Returns:

the package details on the given package file id.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageDetailsListById

@ResponseWrapper(className="com.trendmicro.grid.acl.l0.wrappers.GetPackageDetailsListByIdResponse")
@RequiredRoles(value={"run.package.queries","access.details"})
Collection<PackageDetails> getPackageDetailsListById(BatchCollection<FileIdentifier> files)
                                                     throws AuthenticationException

Returns the package details on the given package file ids.

Parameters:

files - The SHA1 hashes of the package files.

Returns:

the package details on the given package file ids.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageDetailsByName

@RequiredRoles(value={"run.package.queries","access.details"})
PackageDetails getPackageDetailsByName(String packageName)
                                       throws AuthenticationException

Returns the package details on the given package name.

Parameters:

packageName - The name the package.

Returns:

the package details on the given package name.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.

getPackageDetailsListByName

@ResponseWrapper(className="com.trendmicro.grid.acl.l0.wrappers.GetPackageDetailsListByNameResponse")
@RequiredRoles(value={"run.package.queries","access.details"})
Collection<PackageDetails> getPackageDetailsListByName(BatchCollection<String> packageNames)
                                                       throws AuthenticationException

Returns the package details on the given package names.

Parameters:

packageNames - The names the packages to lookup.

Returns:

the package details on the given package names.

Throws:

AuthenticationException - In case of this service requires authentication and the current user session is not authenticated or doesn't have the right to access the service.