com.xpn.xwiki.plugin.packaging
Class Package

java.lang.Object
  extended bycom.xpn.xwiki.plugin.packaging.Package

public class Package
extends java.lang.Object


Field Summary
private  java.lang.String authorName
           
private  boolean backupPack
           
static java.lang.String DefaultPackageFileName
           
static java.lang.String DefaultPluginName
           
private  java.lang.String description
           
private  java.util.List files
           
private  java.lang.String licence
           
private  java.lang.String name
           
static int OK
           
static int Right
           
private  java.lang.String version
           
private  boolean withVersions
           
 
Constructor Summary
Package()
           
 
Method Summary
 boolean add(java.lang.String docFullName, int DefaultAction, XWikiContext context)
           
 boolean add(java.lang.String docFullName, XWikiContext context)
           
 boolean add(XWikiDocument doc, int defaultAction, XWikiContext context)
           
 boolean add(XWikiDocument doc, XWikiContext context)
           
 void addAllWikiDocuments(XWikiContext context)
           
private  void addInfosToZip(java.util.zip.ZipOutputStream zos)
           
 java.lang.String export(java.io.OutputStream os, XWikiContext context)
           
protected  org.dom4j.Document fromXml(java.lang.String xml)
           
 java.lang.String getAuthorName()
           
 java.lang.String getDescription()
           
protected  java.lang.String getElementText(org.dom4j.Element docel, java.lang.String name)
           
 java.util.List getFiles()
           
 java.lang.String getLicence()
           
 java.lang.String getName()
           
 java.lang.String getVersion()
           
 java.lang.String Import(byte[] file, XWikiContext context)
           
 int install(XWikiContext context)
           
private  int installDocument(DocumentInfo doc, XWikiContext context)
           
 boolean isBackupPack()
           
 boolean isWithVersions()
           
private  XWikiDocument readZipDoc(java.lang.String XmlFile)
           
private  java.lang.String readZipFile(java.util.zip.ZipInputStream zis)
           
private  org.dom4j.Document ReadZipInfoFile(java.util.zip.ZipInputStream zis)
           
private  org.dom4j.Document ReadZipPackage(java.util.zip.ZipInputStream zis)
           
 void setAuthorName(java.lang.String authorName)
           
 void setBackupPack(boolean backupPack)
           
 void setDescription(java.lang.String description)
           
private  void setDocumentDefaultAction(java.lang.String docName, int defaultAction)
           
 void setLicence(java.lang.String licence)
           
 void setName(java.lang.String name)
           
 void setVersion(java.lang.String version)
           
 void setWithVersions(boolean withVersions)
           
 int testInstall(XWikiContext context)
           
 java.lang.String toXml()
           
private  org.dom4j.Document toXmlDocument()
           
 boolean updateDoc(java.lang.String docFullName, int action, XWikiContext context)
           
private  void updateFileInfos(org.dom4j.Document xml)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

private java.lang.String name

description

private java.lang.String description

version

private java.lang.String version

licence

private java.lang.String licence

authorName

private java.lang.String authorName

files

private java.util.List files

backupPack

private boolean backupPack

withVersions

private boolean withVersions

OK

public static final int OK
See Also:
Constant Field Values

Right

public static final int Right
See Also:
Constant Field Values

DefaultPackageFileName

public static final java.lang.String DefaultPackageFileName
See Also:
Constant Field Values

DefaultPluginName

public static final java.lang.String DefaultPluginName
See Also:
Constant Field Values
Constructor Detail

Package

public Package()
Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getLicence

public java.lang.String getLicence()

setLicence

public void setLicence(java.lang.String licence)

getAuthorName

public java.lang.String getAuthorName()

setAuthorName

public void setAuthorName(java.lang.String authorName)

isBackupPack

public boolean isBackupPack()

setBackupPack

public void setBackupPack(boolean backupPack)

getFiles

public java.util.List getFiles()

isWithVersions

public boolean isWithVersions()

setWithVersions

public void setWithVersions(boolean withVersions)

add

public boolean add(XWikiDocument doc,
                   int defaultAction,
                   XWikiContext context)
            throws XWikiException
Throws:
XWikiException

add

public boolean add(XWikiDocument doc,
                   XWikiContext context)
            throws XWikiException
Throws:
XWikiException

updateDoc

public boolean updateDoc(java.lang.String docFullName,
                         int action,
                         XWikiContext context)
                  throws XWikiException
Throws:
XWikiException

add

public boolean add(java.lang.String docFullName,
                   int DefaultAction,
                   XWikiContext context)
            throws XWikiException
Throws:
XWikiException

add

public boolean add(java.lang.String docFullName,
                   XWikiContext context)
            throws XWikiException
Throws:
XWikiException

export

public java.lang.String export(java.io.OutputStream os,
                               XWikiContext context)
                        throws java.io.IOException,
                               XWikiException
Throws:
java.io.IOException
XWikiException

Import

public java.lang.String Import(byte[] file,
                               XWikiContext context)
                        throws java.io.IOException,
                               XWikiException
Throws:
java.io.IOException
XWikiException

updateFileInfos

private void updateFileInfos(org.dom4j.Document xml)

setDocumentDefaultAction

private void setDocumentDefaultAction(java.lang.String docName,
                                      int defaultAction)

testInstall

public int testInstall(XWikiContext context)

install

public int install(XWikiContext context)
            throws XWikiException
Throws:
XWikiException

installDocument

private int installDocument(DocumentInfo doc,
                            XWikiContext context)
                     throws XWikiException
Throws:
XWikiException

readZipFile

private java.lang.String readZipFile(java.util.zip.ZipInputStream zis)
                              throws java.io.IOException
Throws:
java.io.IOException

readZipDoc

private XWikiDocument readZipDoc(java.lang.String XmlFile)

ReadZipInfoFile

private org.dom4j.Document ReadZipInfoFile(java.util.zip.ZipInputStream zis)
                                    throws java.io.IOException,
                                           org.dom4j.DocumentException
Throws:
java.io.IOException
org.dom4j.DocumentException

ReadZipPackage

private org.dom4j.Document ReadZipPackage(java.util.zip.ZipInputStream zis)
                                   throws java.io.IOException,
                                          org.dom4j.DocumentException
Throws:
java.io.IOException
org.dom4j.DocumentException

toXml

public java.lang.String toXml()

toXmlDocument

private org.dom4j.Document toXmlDocument()

addInfosToZip

private void addInfosToZip(java.util.zip.ZipOutputStream zos)

getElementText

protected java.lang.String getElementText(org.dom4j.Element docel,
                                          java.lang.String name)

fromXml

protected org.dom4j.Document fromXml(java.lang.String xml)
                              throws org.dom4j.DocumentException
Throws:
org.dom4j.DocumentException

addAllWikiDocuments

public void addAllWikiDocuments(XWikiContext context)
                         throws XWikiException
Throws:
XWikiException


Copyright 2003 Ludovic Dubost