com.trendmicro.grid.acl.l0
Interface PackageService

All Superinterfaces:
PublicPackageService, Service

@ProtectedRequestContext
@WebServlet(value="/ws/level-0/internal/packages")
public interface PackageService
extends PublicPackageService

Defines package related web services, that may be used inside the TM network.

Version:
1.0
Author:
Juergen_Kellerer, 2010-04-29

Method Summary
 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.
 PackageFamily getPackageFamily(String basename)
          Returns the package family on the given basename.
 Vendor getVendor(String name)
          Returns the vendor information for the given vendor name.
 
Methods inherited from interface com.trendmicro.grid.acl.l0.PublicPackageService
getFilesContainedInPackageById, getFilesContainedInPackageByName, getMatchingPackageNames, getMatchingPackageNamesInRange, getPackageDisplayNames, getPackageFamilyDisplayNames, getPackageFamilyNames, getPackageFamilyNamesForVendor, getPackageFileIdentifiersByName, getPackageInformationById, getPackageInformationByName, getPackageInformationListById, getPackageInformationListByName, getPackageNamesInFamily, getPackageNamesTaggedWith, getPackagesContainedInPackageById, getPackagesContainedInPackageByName, getReferencingPackageNames, getReferencingPackageNamesById, getVendorDisplayNames, getVendorNames, isPackagesTaggedWithAllById, isPackagesTaggedWithAllByName, isPackagesTaggedWithById, isPackagesTaggedWithByName, isPackageTaggedWithAllById, isPackageTaggedWithAllByName, isPackageTaggedWithById, isPackageTaggedWithByName
 

Method Detail

getVendor

@RequiredRoles(value={"run.package.queries","access.details","access.protected.services"})
Vendor getVendor(String name)
                 throws AuthenticationException
Returns the vendor information for the given vendor name.

Specified by:
getVendor in interface PublicPackageService
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","access.protected.services"})
PackageFamily getPackageFamily(String basename)
                               throws AuthenticationException
Returns the package family on the given basename.

Specified by:
getPackageFamily in interface PublicPackageService
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","access.protected.services"})
PackageDetails getPackageDetailsById(FileIdentifier file)
                                     throws AuthenticationException
Returns the package details on the given package file id.

Specified by:
getPackageDetailsById in interface PublicPackageService
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","access.protected.services"})
Collection<PackageDetails> getPackageDetailsListById(BatchCollection<FileIdentifier> files)
                                                     throws AuthenticationException
Returns the package details on the given package file ids.

Specified by:
getPackageDetailsListById in interface PublicPackageService
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","access.protected.services"})
PackageDetails getPackageDetailsByName(String packageName)
                                       throws AuthenticationException
Returns the package details on the given package name.

Specified by:
getPackageDetailsByName in interface PublicPackageService
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","access.protected.services"})
Collection<PackageDetails> getPackageDetailsListByName(BatchCollection<String> packageNames)
                                                       throws AuthenticationException
Returns the package details on the given package names.

Specified by:
getPackageDetailsListByName in interface PublicPackageService
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.