com.day.jcr.vault.packaging.JcrPackageDefinition Maven / Gradle / Ivy
/*************************************************************************
*
* ADOBE CONFIDENTIAL
* __________________
*
* Copyright 2011 Adobe Systems Incorporated
* All Rights Reserved.
*
* NOTICE: All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any. The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by trade secret or copyright law.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
*
**************************************************************************/
package com.day.jcr.vault.packaging;
import java.io.IOException;
import java.util.Calendar;
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import com.day.jcr.vault.fs.api.ProgressTrackerListener;
import com.day.jcr.vault.fs.api.WorkspaceFilter;
import com.day.jcr.vault.fs.config.MetaInf;
import com.day.jcr.vault.fs.io.AccessControlHandling;
/**
* Specifies the interface of a package definition stored in the repository.
*
* @deprecated since 2.5.0. Use the org.apache.jackrabbit.vault API instead.
*/
@Deprecated
public interface JcrPackageDefinition {
/**
* Property name of the last unpacked date
*/
public static final String PN_LAST_UNPACKED = "lastUnpacked";
/**
* Property name of the last unpacked user id
*/
public static final String PN_LAST_UNPACKED_BY = "lastUnpackedBy";
/**
* Property name of the creation date
*/
public static final String PN_CREATED = "jcr:created";
/**
* Property name of the creation user id
*/
public static final String PN_CREATED_BY = "jcr:createdBy";
/**
* Property name of the last modification date
*/
public static final String PN_LASTMODIFIED = "jcr:lastModified";
/**
* Property name of the last modification user id
*/
public static final String PN_LASTMODIFIED_BY = "jcr:lastModifiedBy";
/**
* Property name of the last wrapped date
* @since 2.2.22
*/
public static final String PN_LAST_WRAPPED = "lastWrapped";
/**
* Property name of the last wrapped user id
* @since 2.2.22
*/
public static final String PN_LAST_WRAPPED_BY = "lastWrappedBy";
/**
* Property name of the package description
*/
public static final String PN_DESCRIPTION = "jcr:description";
/**
* Property name of the package version
*/
public static final String PN_VERSION = "version";
/**
* Property name of the build count
*/
public static final String PN_BUILD_COUNT = "buildCount";
/**
* Property name of the installation path
* @deprecated since 2.2. use 'name' and 'group' instead
*/
@Deprecated
public static final String PN_PATH = "path";
/**
* Property name of the 'name'
* @since 2.2
*/
public static final String PN_NAME = "name";
/**
* Property name of the 'group'
* @since 2.2
*/
public static final String PN_GROUP = "group";
/**
* Property name of the "requires root" flag
*/
public static final String PN_REQUIRES_ROOT = "requiresRoot";
/**
* Property name of the "require restart" flag
*/
public static final String PN_REQUIRES_RESTART = "requiresRestart";
/**
* Property name of the package dependencies
*/
public static final String PN_DEPENDENCIES = "dependencies";
/**
* Property name of the sub packages (only used in snapshots)
*/
public static final String PN_SUB_PACKAGES = "subPackages";
/**
* Property name of the last unwrapped date
*/
public static final String PN_LAST_UNWRAPPED = "lastUnwrapped";
/**
* Property name of the last unwrapped user id
*/
public static final String PN_LAST_UNWRAPPED_BY = "lastUnwrappedBy";
/**
* Property name of the access control handling mode
*/
public static final String PN_AC_HANDLING = "acHandling";
/**
* Property name of the cnd pattern filter
*/
public static final String PN_CND_PATTERN = "cndPattern";
/**
* Node name of the filter node
*/
public static final String NN_FILTER = "filter";
/**
* Property name of the filter root
*/
public static final String PN_ROOT = "root";
/**
* Property name of the filter root
*/
public static final String PN_MODE = "mode";
/**
* Property name of the filter rules
*/
public static final String PN_RULES = "rules";
/**
* Property name of the rule type
*/
public static final String PN_TYPE = "type";
/**
* Property name of the rule pattern
*/
public static final String PN_PATTERN = "pattern";
/**
* Property name of the disable intermediate save flag
*/
public static final String PN_DISABLE_INTERMEDIATE_SAVE = "noIntermediateSaves";
/**
* Returns the underlying node
* @return the node
*/
Node getNode();
/**
* Returns the package id
* @return the package id
*/
PackageId getId();
/**
* Writes the properties derived from the package id to the content
* @param id the package id
* @param autoSave if true the changes are saved automatically.
* @since 2.2
*/
void setId(PackageId id, boolean autoSave);
/**
* Checks if this definition is unwrapped, i.e. if the definition structured
* was extracted from a VaultPackage.
* @return true if unwrapped.
*/
boolean isUnwrapped();
/**
* Checks if the definition was modified since it was last wrapped.
* new packages are considered modified.
* @return true if modified
*/
boolean isModified();
/**
* Unwrapps the package definition to the underlying node.
* @param pack the package
* @param force if true unwrapping is forced
* @throws RepositoryException if an error occurs
* @throws IOException if an I/O error occurs
*
* @deprecated use {@link #unwrap(VaultPackage, boolean, boolean)} instead.
*/
@Deprecated
void unwrap(VaultPackage pack, boolean force)
throws RepositoryException, IOException;
/**
* Unwrapps the package definition to the underlying node.
* @param pack the package
* @param force if true unwrapping is forced
* @param autoSave if true modifications are saved automatically
* @throws RepositoryException if an error occurs
* @throws IOException if an I/O error occurs
*/
void unwrap(VaultPackage pack, boolean force, boolean autoSave)
throws RepositoryException, IOException;
/**
* Dumps the coverage of this definition to the given listener
* @param listener the listener
* @throws RepositoryException if an error occurrs
*/
void dumpCoverage(ProgressTrackerListener listener) throws RepositoryException;
/**
* Returns the dependencies stored in this definition
* @return the dependencies
*/
Dependency[] getDependencies();
/**
* Generic method to retrieve a string property of this definition.
* @param name the name of the property.
* @return the property value or null if it does not exist.
*/
String get(String name);
/**
* Generic method to retrieve a boolean property of this definition.
* @param name the name of the property.
* @return the property value or null if it does not exist.
*/
boolean getBoolean(String name);
/**
* Generic method to retrieve a date property of this definition.
* @param name the name of the property.
* @return the property value or null if it does not exist.
*/
Calendar getCalendar(String name);
/**
* Generic method to set a string property to this definition.
* @param name the name of the property
* @param value the value or null to clear the property
* @param autoSave if true the modifications are saved automatically.
*/
void set(String name, String value, boolean autoSave);
/**
* Generic method to set a date property to this definition.
* @param name the name of the property
* @param value the value or null to clear the property
* @param autoSave if true the modifications are saved automatically.
*/
void set(String name, Calendar value, boolean autoSave);
/**
* Generic method to set a boolean property to this definition.
* @param name the name of the property
* @param value the value
* @param autoSave if true the modifications are saved automatically.
*/
void set(String name, boolean value, boolean autoSave);
/**
* Touches the last modified and last modified by property.
* @param now calendar or null
* @param autoSave if true the modifications are saved automatically.
*/
void touch(Calendar now, boolean autoSave);
/**
* Sets the filter to this definition and stores it in a node representation.
*
* @param filter the filter to set
* @param autoSave if true the modifications are saved automatically.
*/
void setFilter(WorkspaceFilter filter, boolean autoSave);
/**
* Returns the last modified date
* @return the last modified date
*/
Calendar getLastModified();
/**
* Returns the last modified user id
* @return the last modified user id
*/
String getLastModifiedBy();
/**
* Returns the created date
* @return the created date
*/
Calendar getCreated();
/**
* Returns the creator user id
* @return the creator
*/
String getCreatedBy();
/**
* Returns the last wrapped date
* @return the last wrapped date
* @since 2.2.22
*/
Calendar getLastWrapped();
/**
* Returns the wrapper user id
* @return the wrapper
* @since 2.2.22
*/
String getLastWrappedBy();
/**
* Returns the last unwrapped date
* @return the last unwrapped date
*/
Calendar getLastUnwrapped();
/**
* Returns the last unwrapped user id
* @return the last unwrapped user id
*/
String getLastUnwrappedBy();
/**
* Returns the date when the package was unpacked
* @return the unpacked date
*/
Calendar getLastUnpacked();
/**
* Returns the user id who unpacked the package
* @return the unpacked user id
*/
String getLastUnpackedBy();
/**
* Returns true if this package needs a admin user to install it.
* @return the "requires root" flag
* @deprecated
*/
@Deprecated
boolean requiresRoot();
/**
* Returns true if this package needs restart after installation.
* @return the "requires restart" flag.
*/
boolean requiresRestart();
/**
* Returns the access control handling defined in the definition, or null
* if not defined.
* @return the access control handling or null
* @since 2.3.2
*/
AccessControlHandling getAccessControlHandling();
/**
* Returns the description of this package
* @return the description
*/
String getDescription();
/**
* Returns the build count of this package
* @return the build count.
*/
long getBuildCount();
/**
* Returns the meta inf of this package
* @return the meta inf
* @throws RepositoryException if an error occurs.
*/
MetaInf getMetaInf() throws RepositoryException;
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy