Index

A C D E F G H I L M N O P R S T U V

## A

AbstractFileAction - Class in com.sun.pkg.client
  Common part between `DirAction` and `FileAction`, which stems from the fact that they both involve in an object in a directory that has the same set of metadata.
Action - Class in com.sun.pkg.client
  An `Action` is the base class for all actions that are contained within packages.

## C

clone() - Method in class com.sun.pkg.client.Fmri
com.sun.pkg.client - package com.sun.pkg.client
  Provides for client-side access to the Image Packaging System (IPS) for Java clients.
compareTo(Action) - Method in class com.sun.pkg.client.Action
  Used internally to sort `Action`s.
compareTo(Fmri) - Method in class com.sun.pkg.client.Fmri
  Compare two Fmris.
compareTo(Version) - Method in class com.sun.pkg.client.Version
  Compare two versions.
compareTo(Version.DotSequence) - Method in class com.sun.pkg.client.Version.DotSequence
completeInstall() - Method in class com.sun.pkg.client.Image
computeTransferFiles() - Method in class com.sun.pkg.client.Image.ImagePlan
  Computes the total number of files that will be downloaded during `Image.ImagePlan.execute()`.
computeTransferSize() - Method in class com.sun.pkg.client.Image.ImagePlan
  Computes the total number of bytes that will be downloaded during `Image.ImagePlan.execute()`.
create(File, String, URL) - Static method in class com.sun.pkg.client.Image
  Creates a new user image at the specified path.

## D

DependAction - Class in com.sun.pkg.client
  A `DependAction` is an action that represents a dependency from one package to another.
DependAction.Type - Enum in com.sun.pkg.client
  Type of dependency.
DirAction - Class in com.sun.pkg.client
  A `DirAction` is an action that represents a directory within the image.

## E

endDownloadPhase() - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when all that have to be downloaded are downloaded.
endFileDownload(int, long) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when a file download is completed.
endInstallPhase() - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when all that have to be installed are installed.
endPackageDownload(Fmri, int) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when downloading for a whole package is completed.
endRemovalPhase() - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when all that have to be removed are removed.
endUpdatePhase() - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when all that have to be updated are updated.
equals(Object) - Method in class com.sun.pkg.client.Action
  Determine if two Actions are the "same".
equals(Object) - Method in class com.sun.pkg.client.Fmri
  Compare to Fmris for equality.
equals(Object) - Method in class com.sun.pkg.client.Version.DotSequence
  Compare two DotSequences for equality.
equals(Object) - Method in class com.sun.pkg.client.Version
  Compare two versions for equality.
excludes - Variable in class com.sun.pkg.client.Image.FmriState
execute() - Method in class com.sun.pkg.client.Image.ImagePlan
  Executes the plan with the empty callback.
execute(boolean, boolean) - Method in class com.sun.pkg.client.Image.ImagePlan
  Executes the plan with the empty callback.
execute(ImagePlanProgressTracker) - Method in class com.sun.pkg.client.Image.ImagePlan
  Execute the actions required to bring about the plan.
execute(ImagePlanProgressTracker, boolean, boolean) - Method in class com.sun.pkg.client.Image.ImagePlan
  Execute the actions required to bring about the plan.

## F

FileAction - Class in com.sun.pkg.client
  A `FileAction` is an action that represents a file within the image.
filterByVariants(Map<String, String>) - Method in class com.sun.pkg.client.Manifest
  Remove all actions that are not selected by the image Variants Returns # of actions removed
findDuplicates() - Method in class com.sun.pkg.client.Manifest
  If this package has a duplicate action, return one such pair.
Fmri - Class in com.sun.pkg.client
  An `Fmri` is an identifier for a package.
Fmri(String) - Constructor for class com.sun.pkg.client.Fmri
  Create an Fmri from a string representation.
Fmri(String, String) - Constructor for class com.sun.pkg.client.Fmri
  Create an Fmri from a package name and version.
fmri - Variable in class com.sun.pkg.client.Image.FmriState
frozen - Variable in class com.sun.pkg.client.Image.FmriState

## G

getActionsByType(Class<T>) - Method in class com.sun.pkg.client.Manifest
  Obtain the actions of a given type.
getAttribute(String) - Method in class com.sun.pkg.client.Manifest
  Returns a package attribute defined by a set action.
getAuthority() - Method in class com.sun.pkg.client.Fmri
  Obtain the authority from the Fmri.
getAuthorityNames() - Method in class com.sun.pkg.client.Image
  Return the authority names defined for this image.
getBranch() - Method in class com.sun.pkg.client.Version
  Returns the branch part of the `Version`.
getCanonicalOSArch() - Static method in class com.sun.pkg.client.SystemInfo
  Get the bitness of the OS.
getGroup() - Method in class com.sun.pkg.client.AbstractFileAction
  Group of the directory/file.
getHash() - Method in class com.sun.pkg.client.FileAction
getHash() - Method in class com.sun.pkg.client.LicenseAction
getInventory(String[], boolean) - Method in class com.sun.pkg.client.Image
  Get the inventory of packages and their associated state.
getManifest(Fmri) - Method in class com.sun.pkg.client.Image
  Get the manifest for a package.
getMetaData() - Method in class com.sun.pkg.client.Image
getMode() - Method in class com.sun.pkg.client.AbstractFileAction
  Directory permission mode in the octal format.
getName() - Method in class com.sun.pkg.client.Fmri
  Obtain the name of the package
getName() - Method in class com.sun.pkg.client.LicenseAction
  Obtain the name of the license.
getName() - Method in class com.sun.pkg.client.SetAction
  Package attribute name.
getOSBitness() - Static method in class com.sun.pkg.client.SystemInfo
  Get the bitness of the OS.
getOwner() - Method in class com.sun.pkg.client.AbstractFileAction
  Owner of the directory/file.
getPackageSize() - Method in class com.sun.pkg.client.Manifest
  Returns the size of the package.
getPath() - Method in class com.sun.pkg.client.AbstractFileAction
  Gets the path of the directory/file.
getPath() - Method in class com.sun.pkg.client.LinkAction
  Gets the path of the symlink.
getPkgDir(File) - Method in class com.sun.pkg.client.Fmri
  Return the directory that is used to store information about all versions of this package
getPkgVersionDir(File) - Method in class com.sun.pkg.client.Fmri
  Return the directory that is used to store information about this particular package version.
getPreferredAuthorityName() - Method in class com.sun.pkg.client.Image
getProposedFmris() - Method in class com.sun.pkg.client.Image.ImagePlan
  Return the Fmris that are proposed for installation as part of this plan.
getProxy() - Static method in class com.sun.pkg.client.SystemInfo
  Obtain proxy based on the updatetool preferences.
getProxySelector() - Static method in class com.sun.pkg.client.SystemInfo
  Obtain a ProxySelector based on the updatetool preferences.
getPublishDate() - Method in class com.sun.pkg.client.Version
  Returns the publish time part of the `Version`.
getRelease() - Method in class com.sun.pkg.client.Version
  Returns the release part of the `Version`.
getRootDirectory() - Method in class com.sun.pkg.client.Image
  Obtain the root directory for this image.
getSize() - Method in class com.sun.pkg.client.Action
  Return the size of the installed bits for this action.
getSize() - Method in class com.sun.pkg.client.FileAction
  Gets the size of this file.
getSize() - Method in class com.sun.pkg.client.LicenseAction
getTarget() - Method in class com.sun.pkg.client.LinkAction
  Gets the target of the symlink.
getTargetFmri() - Method in class com.sun.pkg.client.DependAction
  The `Fmri` specified as a dependency.
getText() - Method in class com.sun.pkg.client.LicenseAction
  Obtain the license text.
getType() - Method in class com.sun.pkg.client.DependAction
  Gets the type of the dependency.
getUpdateCheckFrequency() - Static method in class com.sun.pkg.client.SystemInfo
  Obtain the update check frequency based on the updatetool preferences.
getURLConnectTimeout() - Method in class com.sun.pkg.client.Image
getURLPath() - Method in class com.sun.pkg.client.Fmri
  Return the URL path that is used to look up information about this Fmri.
getURLReadmTimeout() - Method in class com.sun.pkg.client.Image
getValue() - Method in class com.sun.pkg.client.SetAction
  Package attribute value.
getVersion() - Method in class com.sun.pkg.client.Fmri
  Obtain the version of the package
getVersionInstalled(String) - Method in class com.sun.pkg.client.Image
  Given just the package name (e.g., "SUNWbash"), find the version currently installed in this image, and returns its `Fmri` with the version number.
getVersionsInstalled(Collection<String>) - Method in class com.sun.pkg.client.Image
  Plural version of `Image.getVersionInstalled(String)`.

## H

hashCode() - Method in class com.sun.pkg.client.Action
  Implemented to be consistent with `Action.equals(Object)`.
hashCode() - Method in class com.sun.pkg.client.Fmri
hashCode() - Method in class com.sun.pkg.client.Version.DotSequence
hashCode() - Method in class com.sun.pkg.client.Version
  Returns a hash code value for the object.
hideMetaDirectory() - Method in class com.sun.pkg.client.Image
  Change the permissions on the Image meta data directory so that the directory will be hidden.

## I

Image - Class in com.sun.pkg.client
  An `Image` is a directory tree containing the laid-down contents of a self-consistent graph of Packages.
Image(String) - Constructor for class com.sun.pkg.client.Image
  Create an Image object for an existing user image based on a String
Image(File) - Constructor for class com.sun.pkg.client.Image
  Open an Image object for an existing user image based on a File.
Image.FmriState - Class in com.sun.pkg.client
  An `FmriState` represents the current state of an Fmri within the image.
Image.FmriState() - Constructor for class com.sun.pkg.client.Image.FmriState
Image.ImagePlan - Class in com.sun.pkg.client
  An `ImagePlan` takes a list of requested packages, an Image (and its policy restrictions), and returns the set of package operations needed to transform the Image to the list of requested packages.
ImagePlanProgressTracker - Class in com.sun.pkg.client
  Callback handler for `Image.ImagePlan.execute()` to monitor the progress of package add/remove/update operations.
ImagePlanProgressTracker() - Constructor for class com.sun.pkg.client.ImagePlanProgressTracker
IMG_ENTIRE - Static variable in class com.sun.pkg.client.Image
IMG_PARTIAL - Static variable in class com.sun.pkg.client.Image
IMG_USER - Static variable in class com.sun.pkg.client.Image
incorporated - Variable in class com.sun.pkg.client.Image.FmriState
initUpdateToolProps(Properties) - Static method in class com.sun.pkg.client.SystemInfo
  Initialize the updatetool preferences from properties.
installed - Variable in class com.sun.pkg.client.Image.FmriState
installPackages(String...) - Method in class com.sun.pkg.client.Image
  Install packages and any required dependencies.
installPackages(ImagePlanProgressTracker, boolean, boolean, String...) - Method in class com.sun.pkg.client.Image
  Install packages and any required dependencies.
installPackages(boolean, boolean, String...) - Method in class com.sun.pkg.client.Image
installPackages(List<Fmri>) - Method in class com.sun.pkg.client.Image
  Install packages and any required dependencies.
installPackages(boolean, boolean, List<Fmri>) - Method in class com.sun.pkg.client.Image
  Install packages and any required dependencies.
isNull() - Method in class com.sun.pkg.client.Version
  Tests whether this object is equal to the null or empty Version, i.e., Version("")
isSamePackage(Fmri) - Method in class com.sun.pkg.client.Fmri
  Determine whether the given Fmri is for the same package as this Fmri, even if for different versions.
isSelectedBy(String, String, Map<String, String>) - Static method in class com.sun.pkg.client.Variant
  Returns true if the named Variant is selected by the list of Variants.
isSelectedBy(Map<String, String>, Map<String, String>) - Static method in class com.sun.pkg.client.Variant
  Returns true if all of the passed action variant tags are selected by the passed image variants.
isSubsequence(Version.DotSequence) - Method in class com.sun.pkg.client.Version.DotSequence
  Determine if this DotSequence is a subsequence of another.
isSuccessor(Fmri) - Method in class com.sun.pkg.client.Fmri
  Determine whether this Fmri is a successor to the given Fmri
isSuccessor(Version) - Method in class com.sun.pkg.client.Version
  Determine if a version is a successor to this version.
isTherePendingInstall() - Method in class com.sun.pkg.client.Image

## L

LicenseAction - Class in com.sun.pkg.client
  A `LicenseAction` is a file action that represents a license file within the image.
LinkAction - Class in com.sun.pkg.client
  A `LinkAction` is an action that represents a symbolic link within the image.

## M

main(String[]) - Static method in class com.sun.pkg.client.Variant
makeInstallPlan(Collection<String>) - Method in class com.sun.pkg.client.Image
  Create an plan for installing packages and any required dependencies.
makeInstallPlan(Collection<String>, String) - Method in class com.sun.pkg.client.Image
  Create an plan for installing packages and any required dependencies.
makeInstallPlan(String...) - Method in class com.sun.pkg.client.Image
  Create an plan for installing packages and any required dependencies.
makeInstallPlan(String[], String) - Method in class com.sun.pkg.client.Image
makeInstallPlan(List<Fmri>) - Method in class com.sun.pkg.client.Image
  Create an plan for installing packages and any required dependencies.
makeUninstallPlan(Collection<Fmri>) - Method in class com.sun.pkg.client.Image
  Create a plan for removing packages.
Manifest - Class in com.sun.pkg.client
  A `Manifest` is a list of actions within a package.
Manifest(Image, Fmri) - Constructor for class com.sun.pkg.client.Manifest
matches(Fmri) - Method in class com.sun.pkg.client.Fmri
  Check if the given Fmri matches this Fmri.
matches(Version.DotSequence) - Method in class com.sun.pkg.client.Version.DotSequence
matches(Version) - Method in class com.sun.pkg.client.Version
  Determine if a version matches this version A version v matches this version if it is all of the version information that is specified matches the corresponding version information in this version.

## N

nullFmri - Static variable in class com.sun.pkg.client.Fmri

## O

onFileDownloadProgress(int, long) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called periodically while a file is being downloaded.
onInstallAction(Action) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called for each install action, right before it's executed.
onRemovalAction(Action) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called for each removal action, right before it's executed.
onUpdateAction(Action, Action) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called for each update action, right before it's executed.

## P

PREF_AUTH_PFX - Static variable in class com.sun.pkg.client.Fmri

## R

refreshCatalog(String) - Method in class com.sun.pkg.client.Image
  Call refresh on the Catalog for the given authority.
refreshCatalogs() - Method in class com.sun.pkg.client.Image
  Call refresh on all of the Catalogs for this image.
runTests() - Static method in class com.sun.pkg.client.Variant
  Test method.

## S

saveConfig() - Method in class com.sun.pkg.client.Image
  Save the configuration for the image.
SetAction - Class in com.sun.pkg.client
  A `SetAction` is an action that represents package attribute.
setAuthority(String, URL, String) - Method in class com.sun.pkg.client.Image
  Set image authority attributes.
setClientName(String) - Method in class com.sun.pkg.client.Image
  Set the client name to be used in connections to repositories.
setDefaultClientName(String) - Static method in class com.sun.pkg.client.Image
  Set the default client name for all Image objects created in this VM.
setGzipFile(File) - Method in class com.sun.pkg.client.FileAction
setGzipFile(File) - Method in class com.sun.pkg.client.LicenseAction
setMetaData(HashMap<String, String>) - Method in class com.sun.pkg.client.Image
  If provided this metadata is included in any catalog requests via the X-JPkg-MetaData property on the HTTP GET request.
setProperty(String, String) - Method in class com.sun.pkg.client.Image
  Set image property value.
setProxy(Proxy) - Method in class com.sun.pkg.client.Image
  Set the proxy to be used by connenctions to repositories.
setURLConnectTimeout(int) - Method in class com.sun.pkg.client.Image
setURLReadmTimeout(int) - Method in class com.sun.pkg.client.Image
setVariant(String, String) - Method in class com.sun.pkg.client.Image
  Set image variant value.
startActions(int) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called before the three `Action`-based phases are started, to notify the total number of actions combined between those three phases.
startDownloadPhase(int) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when the execution enters the download phase, which is the 1st of the four phases.
startFileDownload(int, long) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when the execution starts downloading a particular file.
startInstallPhase(int) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when the execution gets to the install phase, where a bunch of new files and directories are installed.
startPackageDownload(Fmri, int, long) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when the execution starts downloading files for the given package.
startRemovalPhase(int) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when the execution gets to the removal phase, where a bunch of files and directories are removed.
startUpdatePhase(int) - Method in class com.sun.pkg.client.ImagePlanProgressTracker
  Called when the execution gets to the update phase, where a bunch of files and directories are overwritten/modified.
SystemInfo - Class in com.sun.pkg.client
  `SystemInfo` provides access to system information related to the pkg(5) Java API.
SystemInfo() - Constructor for class com.sun.pkg.client.SystemInfo
SystemInfo.UpdateCheckFrequency - Enum in com.sun.pkg.client

## T

testError(Map<String, String>, Map<String, String>, boolean) - Static method in class com.sun.pkg.client.Variant
tokensToVariantTable(String[]) - Static method in class com.sun.pkg.client.Variant
  Convert an array of tokens of the form "property=value" to a hashtable of variants.
toString() - Method in class com.sun.pkg.client.DependAction
toString() - Method in class com.sun.pkg.client.DirAction
toString() - Method in class com.sun.pkg.client.FileAction
toString() - Method in class com.sun.pkg.client.Fmri
  Return the String representation of the Fmri.
toString() - Method in class com.sun.pkg.client.Image.ImagePlan
  Generate a string representation for the ImagePlan.
toString() - Method in class com.sun.pkg.client.LicenseAction
toString() - Method in class com.sun.pkg.client.LinkAction
toString() - Method in class com.sun.pkg.client.SetAction
toString() - Method in class com.sun.pkg.client.Version.DotSequence
  Returns a string form of the DotSequence.
toString() - Method in class com.sun.pkg.client.Version
  Returns a string representation for the `Version`.

## U

uninstallPackages(String...) - Method in class com.sun.pkg.client.Image
  Uninstall packages.
uninstallPackages(List<Fmri>) - Method in class com.sun.pkg.client.Image
  Uninstall packages.
upgradable - Variable in class com.sun.pkg.client.Image.FmriState

## V

valueOf(String) - Static method in enum com.sun.pkg.client.DependAction.Type
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.sun.pkg.client.SystemInfo.UpdateCheckFrequency
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.sun.pkg.client.DependAction.Type
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.sun.pkg.client.SystemInfo.UpdateCheckFrequency
  Returns an array containing the constants of this enum type, in the order they are declared.
Variant - Class in com.sun.pkg.client
Variant() - Constructor for class com.sun.pkg.client.Variant
Version - Class in com.sun.pkg.client
  A `Version` represents the version part of an IPS package FMRI.
Version(String) - Constructor for class com.sun.pkg.client.Version
  Create a `Version` based on the given string representation.
Version.DotSequence - Class in com.sun.pkg.client
  The `DotSequence` class represents the x.y.z parts of a Version object.

A C D E F G H I L M N O P R S T U V