Overview

Namespaces

  • Alvine
    • Infrastructure
      • Jenkins
        • Build
          • Action
          • SCM
        • Computer
          • Launcher
          • Monitor
          • Node
        • Job
          • Action
            • Type
          • Config
            • Builders
              • PublishOverSSH
            • BuildWrappers
            • Property
              • ParametersDefinition
                • Parameter
              • SecurityMatrix
                • Permission
                  • Build
                  • Computer
                  • Credential
                  • Jenkins
                  • Job
                  • Release
                  • SCM
                  • View
            • Publisher
            • SCM
              • SVN
                • Browser
            • Trigger
          • QueueItem
          • SCM
        • Plugin
        • Security
          • Authorization
          • Credential
            • PrivateKeySource
            • SCM
            • Store
              • Specification
          • Realm

Classes

  • Publisher
  • TransferSet
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated

Class TransferSet

TransferSet

Über den PublishOverSSH-Builder können Dateien per SCP an einen anderen Server übertragen werden oder es können Befehle über SSH ausgeführt werden. Für diese Funktion muss das Publish-Over-SSH Plugin installiert sein. Für ein Beispiel siehe die Klasse PublishOverSSH

Alvine\Xml\Node
Extended by Alvine\Infrastructure\Jenkins\Job\Config\Node implements Alvine\Core\InstantiableFromProperties
Extended by Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH\TransferSet
Namespace: Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
Package: Alvine\Infrastructure\Jenkins
Category: Alvine
License: Alvine Nutzungslizenz
Author: schukai GmbH info@schukai.de
Version: $Revision:$
Since: 20141118
See: Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
Link: alvine.io
Link: https://wiki.jenkins-ci.org/display/JENKINS/Publish+Over+SSH+Plugin
Located at job/config/builders/publishoverssh/TransferSet.class.php
Methods summary
public
# __construct( Alvine\IO\File\Directory $remote, string $source = '**/*' )

Neues Objekt

Neues Objekt

Über die Zeichenkette $source können die Daten, die übertragen werden sollen, definiert werden. Das Schema für diese Zeichenkette richtet sich nach der Ant-Fileset Spezifikation. So spiezifiziert ** /.php alle PHP-Dateien und ** /xyz/ alle Dateinen im Verzeichnis xyz im Workspace.

Parameters

$remote
Zielverzeichnis auf dem Host
$source
Quelldateien

Link

http://ant.apache.org/manual/dirtasks.html#patterns
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
# setExcludes( array $excludes )

Ausschlüsse

Ausschlüsse

Über diese Methode können mehrere Zeichenketten definiert werden, die Dateien definieren die nicht übertragen werden sollen. So können über ['** /.log','** /.tmp'] Log und temporäre Dateien ausgeschlossen werden.

Parameters

$excludes
Ausschlüsse

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
# setSourcePrefix( string $prefix )

Prefix

Prefix

Über diese Methode kann ein Prefix definiert werden, der beim Übertragen von der Quelldatei verworfen wird. Will man zum Beispiel Quelldatei die im Verzeichnis /assets/images liegen in das Verzeichnis /images speichern, so kann man den Prefix assets/ angeben. Der Prefix muss ein Bestandteil des Source sein.

Parameters

$prefix
Prefix

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
# setRemoteDirectorySDF( boolean $mode )

RemoteDirectorySDF

RemoteDirectorySDF

Bei dieser Option werden bestimmte Buchstaben im Dateinamen durch das Datum ersetzt. So wird aus 'qa-approved/'yyyyMMddHHmmss die Datei qa-approved/20111107154555. Die Bestandteile die nicht ersetzt werden sollen, müssen in Hochkommas stehen.

Parameters

$mode
Modus

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH

Link

https://github.com/jenkinsci/publish-over-ftp-plugin/blob/master/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpTransfer/help-remoteDirectorySDF.html
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
# setFlatten( boolean $mode )

Flatten

Flatten

Bei dieser Option werden keine Verzeichnisse angelegt, sondern alle Datein in das betreffende Zielverzeichnis geschrieben.

Parameters

$mode
Modus

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH

Link

https://github.com/jenkinsci/publish-over-ftp-plugin/blob/master/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpTransfer/help-flatten.html
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
# setCleanRemote( boolean $mode )

setCleanRemote

setCleanRemote

Bei dieser Option werden alle Dateien im Zielverzeichnis gelöscht, bevor die neuen Dateien übertragen werden.

Parameters

$mode
Modus

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH

Link

https://github.com/jenkinsci/publish-over-ftp-plugin/blob/master/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpTransfer/help-cleanRemote.html
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
# setDefaultExcludes( boolean $mode )

setDefaultExcludes

setDefaultExcludes

Die Java-Klasse DirectoryScanner besitzt einen Filter, der bestimmte Dateien ausschliesst. Mit dieser Option kann das Verhalten gesteuert werden. Defaultausschlüsse sind zum Beispiel Dateien der Versionsverwaltungssysteme wie GIT, SVN oder CVS.

Der Konfigurationswert heisst noDefaultExcludes. True, bzw. false steuert das entsprechende Verhalten.

Parameters

$mode
Modus

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH

Link

https://svn.apache.org/repos/asf/ant/core/trunk/src/main/org/apache/tools/ant/DirectoryScanner.java
http://www.jajakarta.org/ant/ant-1.6.1/docs/en/manual/api/org/apache/tools/ant/DirectoryScanner.html#getDefaultExcludes()
https://github.com/jenkinsci/publish-over-ftp-plugin/blob/master/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpTransfer/help-noDefaultExcludes.jelly
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
# setMakeEmptyDirs( boolean $mode )

makeEmptyDirs

makeEmptyDirs

Im Regelfall werden nur Verzeichnisse angelegt, in die auch Dateien übertragen werden. Leere Verzecihnisse werden nur angelegt, wenn diese Option aktiviert wurde.

Parameters

$mode
Modus

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH

Link

https://github.com/jenkinsci/publish-over-ftp-plugin/blob/master/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpTransfer/help-makeEmptyDirs.html
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
# setExecTimeout( integer $seconds )

execTimeout

execTimeout

Nach überschreitung des Timeouts wird die Verarbeitung abgebrochen.

Parameters

$seconds
Sekunden

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
# setUsePty( boolean $mode )

usePty

usePty

Bei dieser Option wird eine echt Pty-Konsole verwendet. Dies ist dann notwendig, wenn das Zielprogramm nur mit einer echten Konsole arbeiten kann.

Parameters

$mode
Modus

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH
public Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH\TransferSet
# setExecCommand( string $command )

SSH Befehl

SSH Befehl

Parameters

$command
SSH Befehl

Returns

Alvine\Infrastructure\Jenkins\Job\Config\Builders\PublishOverSSH\TransferSet
public static object
# getInstanceFromProperties( Alvine\Types\Properties $properties )

Objekt aus Eigenschaft erstellen

Objekt aus Eigenschaft erstellen

Erstellt ein neues Objekt und initialisiert Werte aus einer Eigenschaftsklasse

Die Methode erwatrtet die Eigenschaft local, remote, execcommand, usepty, exectimeout, makeemptydirs, defaultexcludes, cleanremote, flatten, remotedirectorysdf, sourceprefix, excludes

Parameters

$properties
Eigenschaften

Returns

object
Neues Objekt

Overrides

Alvine\Infrastructure\Jenkins\Job\Config\Node::getInstanceFromProperties()
Methods inherited from Alvine\Infrastructure\Jenkins\Job\Config\Node
addOrReplaceConfigNode(), equals(), setAndReplaceConfigNode()
alvine.infrastructure.jenkins API-Dokumentation 0.11.0 | © schukai GmbH | Impressum