Methods summary
protected
Alvine\Types\ArrayHelper
|
#
getArrayHelperFromResponse( Alvine\Net\Http\Response $response )
Hilfsmethode
Erstellt aus einer Rückgabe ein ArrayHelper-Objekt.
Parameters
Returns
Alvine\Types\ArrayHelper
Throws
Alvine\Types\TypeException
|
public
Alvine\Infrastructure\Jenkins\Build
|
#
getBuild( string $name, integer $buildNumber )
Build
Mit dieser Methode lässt sich der Durchlauf
$buildNumber im Projekt $name abrufen.
$client = new \Alvine\Infrastructure\Jenkins\Client(new Alvine\Net\Resource\URI('http://jenkins/'));
$obj = $client->getBuild('myProject',3);
echo $obj->getFullDisplayName();
Das Ergebnis ist in diesem Fall "myProject #3"
Parameters
- $name
- Name des Jobs
- $buildNumber
- Nummer des builds
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Build>
|
#
getBuilds( string $name )
Builds
Um eine Liste mit allen verfügbaren Build
von Jenkins abzurufen, kann mit getBuild
eine Collection abgerufen werden. Die Collection
enthält alle Informationen, die auch von
(@see \Alvine\Infrastructure\Jenkins\Build)
Parameters
Returns
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Build>
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Job
|
#
getJob( string $name )
Job
Holen aller Daten des Jobs mit dem Namen $name
vom Jenkins-Server.
Parameters
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Job>
|
#
getJobs( )
Jobliste
Auflistung alle in Jenkins
mit den Zugangsdaten sichtbaren Jobs
Returns
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Job>
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
|
public
Alvine\Infrastructure\Jenkins\Job\Config
|
#
getJobConfig( string $name )
Konfiguration auslesen
Parameters
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Build\Log
|
#
getBuildLog( string $name, integer $buildNumber )
Ausgabe des Build laden
Parameters
- $name
- Name
- $buildNumber
- Nummer
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
createJob( string $name, Alvine\Infrastructure\Jenkins\Job\Config $config )
Job anlegen
ein Job wird über eine XML-Konfiguration angelegt.
$xml = '...';
$c = $client->createJob('freestyle', new
\Alvine\Infrastructure\Jenkins\Job\Config($xml));
Parameters
- $name
- Name des Jobs
- $config
- Konfiguration
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
updateJob( string $name, Alvine\Infrastructure\Jenkins\Job\Config $config )
Job Konfiguration ändern
Die Änderung der Konfiguration erfolgt über das
Einspielen einer neuen Konfigurations-XML.
$xml = '...';
$config = new \Alvine\Infrastructure\Jenkins\Job\Config($xml);
$log = $client->updateJob('freestyle', $config);
Parameters
- $name
- Name des Jobs
- $config
- Konfiguration
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
protected
Alvine\Infrastructure\Jenkins\Client
|
#
setEnableDisableModeToJob( string $name, string $mode )
Status setzen
Ein Job kann deaktiviert werden, um zum Beispiel
die Ausführung in einer bestimmten zeit zu verhindern.
Parameters
- $name
- Name des Jobs
- $mode
- enable oder disable
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
disableJob( string $name )
Job deaktivieren
Ein Job kann deaktiviert werden, um zum Beispiel
die Ausführung in einer bestimmten zeit zu verhindern.
Ein deaktiverter Job führt keine SCM Abfrage durch
und ist auch über die Benutzerschnittstelle
nicht startbar.
Parameters
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
enableJob( string $name )
Job aktivieren
einen vorher deaktivierten Vorgang wieder aktivieren.
Parameters
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
build( string $name )
Bauen
Dieser Befehl startet einen Build-Durchlauf
ohne Parameter. Sind für den Job Parameter
definiert, so muss stattdessen
(@see \Alvine\Infrastructure\Jenkins\Client::buildWithParameters())
verwendet werden.
Parameters
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
buildWithParameters( string $name, Alvine\Net\Http\FormData $formdata )
Bauen mit Parametern anstoßen
Bauen mit Parametern anstoßen
Für das Bauen mit Parametern müssen die Parameter als
Objekt der Klasse @see \Alvine\Net\Http\FormData übergeben
werden.
Parameters
- $name
- Name des Jobs
- $formdata
- Parameter
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
deleteJob( string $name )
Job löschen
Achtung: Nach dem Löschen sind die Daten nicht mehr verfügbar und können nicht wiederhergestellt werden.
$user = new Alvine\Security\Authentication\User('myLogin');
$password = new Alvine\Security\Authentication\Credential\Password('myPassword');
$credential = new \Alvine\Net\Http\Authentication\Scheme\Basic($user, $password);
$client = new \Alvine\Infrastructure\Jenkins\Client(new Alvine\Net\Resource\URI('http://jenkins/'));
$client->setCredential($credential);
$client->deleteJob('freestyle');
Parameters
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\User
|
#
getUser( string $name )
Benutzer
Der Benutzer enhält einige wichtige
Informationen zu dem User.
Parameters
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
deleteComputerNode( string $name )
Node entfernen
Parameters
Returns
|
public
Alvine\Infrastructure\Jenkins\Client
|
|
public
Alvine\Infrastructure\Jenkins\Computer
|
#
getComputer( string $name )
Computer laden
Jenkins kann in einem Cluster mit mehreren Rechnern betrieben werden.
Über die Methoden \Alvine\Infrastructure\Jenkins\Client::getComuters() und
\Alvine\Infrastructure\Jenkins\Client::getComputer() können diese
Informationen abgefragt werden.
Besonders wichtig sind hier die Informationen zu Auslastung und
Festplattenkapazität.
Hinweis: Beim Master ist der Name in Klammern zu setzen (master)
Parameters
Returns
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
Alvine\Core\ArgumentEmptyException Der Name darf nicht leer sein
|
public
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Computer>
|
#
getComputers( )
Computerliste
Aulistung aller Computer im Jenkins-Cluster
Returns
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Computer> Computer
Throws
Alvine\Types\Mime\MIMETypeException Der MimeType entspreicht nicht den Vorgaben
Alvine\Net\ConnectionFailedException Keine Verbindung möglich
Alvine\Net\Http\ServerException Unspezifizierter Fehler
Alvine\Net\Http\NotFoundException URI nicht gefunden
|
public
Alvine\Infrastructure\Jenkins\Client
|
|
public
Alvine\Infrastructure\Jenkins\Credentials
|
#
getDomainCredentials( string $domain = '_' )
Hinterlegte Zugangsdaten
$credentials = $client->getDomainCredentials('alvine');
foreach($credentials->getCredentials() as $obj) {
$credential = $client->getDomainCredential($obj->getID(), 'alvine');
echo $credential->getFullName()."\n";
}
Parameters
Returns
|
public
|
#
getDomainCredential( string $id, string $domain = '_' )
Details zu einzelnen Zugangsdaten ermitteln
Details zu einzelnen Zugangsdaten ermitteln
$credentials = $client->getDomainCredentials('alvine');
foreach($credentials->getCredentials() as $obj) {
$credential = $client->getDomainCredential($obj->getID(), 'alvine');
echo $credential->getFullName()."\n";
}
Parameters
- $id
- ID ID derZugangsdaten
- $domain
- Domain Domain
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
quietDown( )
Jenkins herunterfahren
Returns
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
cancelQuietDown( )
Jenkins herunterfahren abbrechen
Jenkins herunterfahren abbrechen
Returns
|
public
Alvine\Infrastructure\Jenkins\Client
|
|
public
Alvine\Infrastructure\Jenkins\Client
|
|
public
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Plugin\Available>
|
#
getAvailablePlugins( )
Verfügbare Plugins
Returns
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Plugin\Available>
|
public
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Plugin\Installed>
|
#
getInstalledPlugins( )
Installierte Plugins
Returns
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Plugin\Installed>
|
public
boolean
|
#
isRestartRequired( )
Überprüfen ob Jenkins neu gestartet werden muss.
Überprüfen ob Jenkins neu gestartet werden muss.
Returns
boolean Neustart bei true notwendig
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
performPluginUpdateCheck( )
Prüfen ob Updates vorliegen
Prüfen ob Updates vorliegen
Falls Updates vorliegen, so können diese mittels
Client::getAvailablePluginUpdates() ermittelt werden.
Nach einem Neustart Client::quietDown() stehen die Plugins
dann zur Verfügung.
Returns
|
public
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Plugin>
|
#
getAvailablePluginUpdates( )
Verfügbare Updates
Returns
Alvine\Types\Collection<\Alvine\Infrastructure\Jenkins\Plugin>
|
protected
Alvine\Infrastructure\Jenkins\Client
|
#
doPluginAction( string $pluginName, string $action )
Plugin-Aktion ausführen
Parameters
- $pluginName
- Name des Plugins
- $action
- Aktion
Returns
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
unpinPlugin( string $pluginName )
Plugin entsperren
Parameters
- $pluginName
- Name des Plugins
Returns
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
pinPlugin( string $pluginName )
Plugin sperren
Parameters
- $pluginName
- Name des Plugins
Returns
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
uninstallPlugin( string $pluginName )
Plugin deinstallieren
Parameters
- $pluginName
- Name des Plugins
Returns
|
public
Alvine\Infrastructure\Jenkins\Client
|
#
installPlugin( string $pluginName, string $version = 'latest' )
Plugin installieren
Parameters
- $pluginName
- Name des Plugins
- $version
- Version
Returns
Throws
Alvine\Net\Http\ServerException Fehler beim Installieren der Plugins
|
public
Alvine\Infrastructure\Jenkins\Client
|
|