com.hlcl.rql.as
Class PublishingTarget

java.lang.Object
  com.hlcl.rql.as.PublishingTarget

All Implemented Interfaces:

CmsClientContainer, ProjectContainer

public class PublishingTarget
extends java.lang.Object
implements ProjectContainer

Diese Klasse beschreibt ein Exportziel.

Author:

LEJAFR

Constructor Summary

PublishingTarget(Project project, java.lang.String publishingTargetGuid, java.lang.String name, java.lang.String path, java.lang.String type)
constructor comment.

Method Summary

RQLNode	callCms(java.lang.String rqlRequest) Senden eine Anfrage an das CMS und liefert eine geparste Antwort zurueck.
java.lang.String	callCmsWithoutParsing(java.lang.String rqlRequest) Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck.
void	disableFtpUser() Setzt den Benutzernamen und das Passwort des FTP users auf 'unknown'.
boolean	equals(java.lang.Object obj) Zwei Exportziele werden als gleich betrachtet, wenn ihre GUID übereinstimmt.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getFtpPassword() Liefert das Passwort des FTP Users dieses Publizierungsziels zurück.
java.lang.String	getFtpUserName() Liefert den Namen des FTP Users dieses Publizierungsziels zurück.
java.lang.String	getLogonGuid() Liefert die RedDot logon GUID des users unter dem das script läuft.
java.lang.String	getName() Liefert den Namen dieses Exportpaketes.
java.lang.String	getPath() Liefert den Pfad, auf den dieses Exportziel generiert genauso, wie er in RedDot eingegeben wurde.
java.lang.String	getPathSeparator() Liefert abhängig vom publishing target typ den Pfadseparator; / für FTP oder SFTP und \ für directory.
Project	getProject() Liefert das Project, zu dem dieser Folder gehoert.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getPublishingPath() Liefert den Pfad, auf den dieses Exportziel generiert; immer ohne path separator(/ oder \) am Ende.
java.lang.String	getPublishingPath(PublicationFolder publicationFolder) Liefert den Pfad, auf den dieses Exportziel für den gegebenen Folder generiert; immer ohne path separator(/ oder \) am Ende.
java.lang.String	getPublishingTargetGuid() Liefert die GUID dieses Exportzieles.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
int	hashCode() Liefert den hashcode dieses targets.
boolean	isDirectoryTarget() Liefert true, falls dieses publishing target ein Directory, lokal oder UNC, ist.
boolean	isFtpTarget() Liefert true, falls dieses publishing target ein FTP oder SFTP Target ist.
boolean	isLiveServerTarget() Liefert true, falls dieses publishing target ein Live Server target ist.
void	setFtpPassword(java.lang.String newPassword) Ändert für dieses FTP Publizierungsziel das Passwort des verwendeten FTP users.
void	setFtpUserName(java.lang.String newUserName) Ändert für dieses FTP Publizierungsziel den verwendeten FTP user.
java.lang.String	toString() Show name for easier debugging.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PublishingTarget

public PublishingTarget(Project project,
                        java.lang.String publishingTargetGuid,
                        java.lang.String name,
                        java.lang.String path,
                        java.lang.String type)

constructor comment.

Method Detail

callCms

public RQLNode callCms(java.lang.String rqlRequest)
                throws RQLException

Senden eine Anfrage an das CMS und liefert eine geparste Antwort zurueck.

Specified by:

callCms in interface CmsClientContainer

Throws:

RQLException

callCmsWithoutParsing

public java.lang.String callCmsWithoutParsing(java.lang.String rqlRequest)
                                       throws RQLException

Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck. Erforderlich für die Ermittlung des Werts eines Textelements.

Specified by:

callCmsWithoutParsing in interface CmsClientContainer

Throws:

RQLException

equals

public boolean equals(java.lang.Object obj)

Zwei Exportziele werden als gleich betrachtet, wenn ihre GUID übereinstimmt.

Overrides:

equals in class java.lang.Object

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getFtpPassword

public java.lang.String getFtpPassword()
                                throws RQLException

Liefert das Passwort des FTP Users dieses Publizierungsziels zurück.

Throws:

WrongPublishingTargetTypeException

RQLException

getFtpUserName

public java.lang.String getFtpUserName()
                                throws RQLException

Liefert den Namen des FTP Users dieses Publizierungsziels zurück.

Throws:

WrongPublishingTargetTypeException

RQLException

disableFtpUser

public void disableFtpUser()
                    throws RQLException

Setzt den Benutzernamen und das Passwort des FTP users auf 'unknown'.

Über dieses FTP Ziel kann danach nicht mehr publiziert werden.

Throws:

WrongPublishingTargetTypeException - falls kein FTP publishing target vorliegt

RQLException

getLogonGuid

public java.lang.String getLogonGuid()

Liefert die RedDot logon GUID des users unter dem das script läuft. Dies ist nicht die des Users, falls er angemeldet ist!

Specified by:

getLogonGuid in interface CmsClientContainer

See Also:

getOwnLoginGuid

getName

public java.lang.String getName()

Liefert den Namen dieses Exportpaketes.

Returns:

java.lang.String

getPath

public java.lang.String getPath()
                         throws RQLException

Liefert den Pfad, auf den dieses Exportziel generiert genauso, wie er in RedDot eingegeben wurde.

Throws:

WrongPublishingTargetTypeException

RQLException

See Also:

isDirectoryTarget(), isFtpTarget(), isLiveServerTarget()

getPathSeparator

public java.lang.String getPathSeparator()
                                  throws RQLException

Liefert abhängig vom publishing target typ den Pfadseparator; / für FTP oder SFTP und \ für directory.

Throws:

WrongPublishingTargetTypeException

RQLException

See Also:

isDirectoryTarget(), isFtpTarget(), isLiveServerTarget()

getProject

public Project getProject()

Liefert das Project, zu dem dieser Folder gehoert.

Specified by:

getProject in interface ProjectContainer

getProjectGuid

public java.lang.String getProjectGuid()
                                throws RQLException

Liefert die RedDot GUID des Projekts.

Specified by:

getProjectGuid in interface ProjectContainer

Throws:

RQLException

getPublishingPath

public java.lang.String getPublishingPath()
                                   throws RQLException

Liefert den Pfad, auf den dieses Exportziel generiert; immer ohne path separator(/ oder \) am Ende.

Funktioniert für FTP, SFTP oder directory Publizierungsziele.

Throws:

RQLException

See Also:

getPathSeparator()

getPublishingPath

public java.lang.String getPublishingPath(PublicationFolder publicationFolder)
                                   throws RQLException

Liefert den Pfad, auf den dieses Exportziel für den gegebenen Folder generiert; immer ohne path separator(/ oder \) am Ende.

Funktioniert für FTP, SFTP oder directory Publizierungsziele.

Throws:

RQLException

See Also:

getPathSeparator()

getPublishingTargetGuid

public java.lang.String getPublishingTargetGuid()

Liefert die GUID dieses Exportzieles.

Returns:

java.lang.String

getSessionKey

public java.lang.String getSessionKey()

Liefert den RedDot Session key.

Specified by:

getSessionKey in interface ProjectContainer

hashCode

public int hashCode()

Liefert den hashcode dieses targets.

Overrides:

hashCode in class java.lang.Object

isDirectoryTarget

public boolean isDirectoryTarget()

Liefert true, falls dieses publishing target ein Directory, lokal oder UNC, ist.

isFtpTarget

public boolean isFtpTarget()

Liefert true, falls dieses publishing target ein FTP oder SFTP Target ist.

isLiveServerTarget

public boolean isLiveServerTarget()

Liefert true, falls dieses publishing target ein Live Server target ist.

setFtpPassword

public void setFtpPassword(java.lang.String newPassword)
                    throws RQLException

Ändert für dieses FTP Publizierungsziel das Passwort des verwendeten FTP users.

Throws:

WrongPublishingTargetTypeException

RQLException

setFtpUserName

public void setFtpUserName(java.lang.String newUserName)
                    throws RQLException

Ändert für dieses FTP Publizierungsziel den verwendeten FTP user.

Throws:

WrongPublishingTargetTypeException

RQLException

toString

public java.lang.String toString()

Show name for easier debugging.

Overrides:

toString in class java.lang.Object