Class

net.adamcin.vltpack.mojo

PackageMojo

Related Doc: package mojo

Permalink

class PackageMojo extends BaseMojo with OutputParameters with CreatesPackage with IdentifiesPackages

Creates a vault package based on the generated metadata and configured content root

Annotations
@Mojo()
Since

0.6.0

Linear Supertypes
IdentifiesPackages, CreatesPackage, OutputParameters, RequiresProject, BaseMojo, AbstractMojo, ContextEnabled, Mojo, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PackageMojo
  2. IdentifiesPackages
  3. CreatesPackage
  4. OutputParameters
  5. RequiresProject
  6. BaseMojo
  7. AbstractMojo
  8. ContextEnabled
  9. Mojo
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PackageMojo()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final val DEFAULT_JCR_PATH: String("/")

    Permalink
    Definition Classes
    CreatesPackage
  5. final val DEFAULT_VLT_ROOT: String("${project.build.outputDirectory}")

    Permalink
  6. final val JCR_ROOT: String("jcr_root")

    Permalink
    Definition Classes
    CreatesPackage
  7. final val META_INF: String("META-INF")

    Permalink
    Definition Classes
    CreatesPackage
  8. final val VAULT_PREFIX: String("META-INF/vault/")

    Permalink
    Definition Classes
    CreatesPackage
  9. def addEntryToZipFile(addToSkip: Boolean, skipEntries: Set[String], entryFile: File, entryName: String, zip: JarOutputStream): Set[String]

    Permalink

    Recursively adds files to the provided zip output stream

    Recursively adds files to the provided zip output stream

    addToSkip

    set to true to add the current entry to the returned set of entries to skip.

    skipEntries

    entry names that should not be added to the zip file

    entryFile

    file that will be copied to the stream if it is not a directory. if it is a directory, it's children will be listed and this method will be called on each as appropriate

    entryName

    name of current entry should it be successfully added to the zip stream

    zip

    zip output stream

    returns

    set of zip entries to skip during subsequent calls to this method

    Definition Classes
    CreatesPackage
  10. def adjustToServerTimeZone(localTime: Long): Long

    Permalink
    Definition Classes
    CreatesPackage
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. lazy val configSha: File

    Permalink
    Definition Classes
    OutputParameters
  14. lazy val configXml: File

    Permalink
    Definition Classes
    OutputParameters
  15. def createPackage(vltRoot: File, zipFile: File, prepareZipFile: (JarOutputStream) ⇒ Set[String]): Unit

    Permalink

    Creates a package from a standard vlt working copy, such that the vltRoot directory has two children, jcr_root and META-INF.

    Creates a package from a standard vlt working copy, such that the vltRoot directory has two children, jcr_root and META-INF.

    vltRoot

    parent of both jcr_root and META-INF

    zipFile

    zip file to write to

    prepareZipFile

    function that prepares the stream by, say, injecting generated versions of entries and returning a Set of those entry names that should be skipped during normal package generation, thus allowing one to merge multiple source trees

    Definition Classes
    CreatesPackage
  16. lazy val definitionDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  17. lazy val definitionSha: File

    Permalink
    Definition Classes
    OutputParameters
  18. lazy val definitionXml: File

    Permalink
    Definition Classes
    OutputParameters
  19. lazy val embedBundlesDirectory: File

    Permalink

    directory containing resolved bundles

    directory containing resolved bundles

    Definition Classes
    OutputParameters
  20. lazy val embedPackagesDirectory: File

    Permalink

    directory containing resolved packages

    directory containing resolved packages

    Definition Classes
    OutputParameters
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  23. def execute(): Unit

    Permalink
    Definition Classes
    PackageMojoBaseMojo → Mojo
  24. lazy val filterSha: File

    Permalink
    Definition Classes
    OutputParameters
  25. lazy val filterXml: File

    Permalink
    Definition Classes
    OutputParameters
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. def getExistingDir(file: File): File

    Permalink
    Definition Classes
    OutputParameters
  29. def getIdFromProperties(props: Properties, defaultId: Option[PackageId]): Option[PackageId]

    Permalink
    Definition Classes
    IdentifiesPackages
  30. def getLog(): Log

    Permalink
    Definition Classes
    AbstractMojo → Mojo
  31. def getPluginContext(): Map

    Permalink
    Definition Classes
    AbstractMojo → ContextEnabled
  32. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  33. lazy val hooksDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  34. def identifyPackage(file: File): Option[PackageId]

    Permalink
    Definition Classes
    IdentifiesPackages
  35. def inputFileModified(output: File, inputFiles: Stream[File]): Boolean

    Permalink
    Definition Classes
    OutputParameters
  36. def inputFileModified(output: File, inputFiles: List[File]): Boolean

    Permalink
    Definition Classes
    OutputParameters
  37. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  38. var jcrPath: String

    Permalink

    Specify the JCR path that the jcr_root folder maps to.

    Specify the JCR path that the jcr_root folder maps to. For instance, if the content was checked out using the vlt command, a jcrPath parameter may have been explicitly specified as something other than '/'. In this case, the same explicit value must be set for this mojo to properly create Jar entries so that the package contents wind up at the correct path when installed

    Definition Classes
    CreatesPackage
  39. lazy val jcrPathNoSlashEnd: String

    Permalink
    Definition Classes
    CreatesPackage
  40. def listFiles(file: File): Stream[File]

    Permalink
    Definition Classes
    OutputParameters
  41. val localTz: TimeZone

    Permalink
    Definition Classes
    CreatesPackage
  42. val log: Logger

    Permalink
    Definition Classes
    CreatesPackage
  43. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  44. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  45. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  46. lazy val outputDirectory: File

    Permalink

    target directory

    target directory

    Definition Classes
    OutputParameters
  47. def overwriteFile(file: File, content: String): Unit

    Permalink
    Definition Classes
    OutputParameters
  48. lazy val packageChecksum: String

    Permalink
  49. lazy val packageDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  50. lazy val packageSha: File

    Permalink
    Definition Classes
    OutputParameters
  51. var project: MavenProject

    Permalink
    Definition Classes
    RequiresProject
  52. val propertiesEntry: String

    Permalink
    Definition Classes
    IdentifiesPackages
  53. lazy val propertiesSha: File

    Permalink
    Definition Classes
    OutputParameters
  54. lazy val propertiesXml: File

    Permalink
    Definition Classes
    OutputParameters
  55. def relativeToBundleInstallPath(bundle: File): String

    Permalink
    Definition Classes
    OutputParameters
  56. var serverTimezone: String

    Permalink

    Specify the server timezone if different from the local timezone.

    Specify the server timezone if different from the local timezone. When CRX installs the package, it will check the lastmodified timestamps on the Jar entries and compare them to the jcr:lastModified properties in the repository to determine if each file should be installed or not. Because the Jar entry timestamp does not account for timezone, it is possible for packages created in different timezones to be installed inconsistently on the same server. By setting this parameter, the Jar entry timestamps will be adjusted to reflect the local time of the server timezone instead of the local timezone

    The value of this property will be passed to TimeZone.getTimeZone(String id), which will be compared against the build machine's default time zone, TimeZone.getDefault(), for computing the desired timestamp offset.

    As described in the TimeZone javadocs, if the value of this property is not empty and is not a valid TimeZone id, the GMT timezone will be used for adjustment of timestamps.

    Definition Classes
    CreatesPackage
  57. lazy val serverTz: TimeZone

    Permalink
    Definition Classes
    CreatesPackage
  58. var session: MavenSession

    Permalink
    Definition Classes
    BaseMojo
  59. def setLog(arg0: Log): Unit

    Permalink
    Definition Classes
    AbstractMojo → Mojo
  60. def setPluginContext(arg0: Map): Unit

    Permalink
    Definition Classes
    AbstractMojo → ContextEnabled
  61. var settings: Settings

    Permalink
    Definition Classes
    BaseMojo
  62. lazy val settingsXml: File

    Permalink
    Definition Classes
    OutputParameters
  63. def shouldCreatePackage: Boolean

    Permalink
  64. def skipOrExecute(skip: Boolean)(body: ⇒ Unit): Unit

    Permalink
    Definition Classes
    BaseMojo
  65. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  66. lazy val targetFile: File

    Permalink

    target vltpack file

    target vltpack file

    Definition Classes
    OutputParameters
  67. lazy val thumbnailDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  68. lazy val thumbnailFileDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  69. lazy val thumbnailFileXml: File

    Permalink
    Definition Classes
    OutputParameters
  70. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  71. lazy val transientRepoDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  72. lazy val uploadDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  73. lazy val uploadSha: File

    Permalink
    Definition Classes
    OutputParameters
  74. lazy val uploadTestsDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  75. lazy val uploadTestsSha: File

    Permalink
    Definition Classes
    OutputParameters
  76. lazy val vaultDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  77. lazy val vaultInfDirectory: File

    Permalink
    Definition Classes
    OutputParameters
  78. lazy val vaultInfMetaInfDirectory: File

    Permalink

    vault-inf-generated META-INF/vault/...

    vault-inf-generated META-INF/vault/... resources

    Definition Classes
    OutputParameters
  79. val vltRoot: File

    Permalink

    Content root directory containing jcr_root and META-INF folders

  80. lazy val vltpackDirectory: File

    Permalink

    directory containing vltpack-generated files

    directory containing vltpack-generated files

    Definition Classes
    OutputParameters
  81. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from IdentifiesPackages

Inherited from CreatesPackage

Inherited from OutputParameters

Inherited from RequiresProject

Inherited from BaseMojo

Inherited from AbstractMojo

Inherited from ContextEnabled

Inherited from Mojo

Inherited from AnyRef

Inherited from Any

Ungrouped