GitHub-Mirror/rundeck-api-java-client
2
0
Fork 0
mirror of https://github.com/Fishwaldo/rundeck-api-java-client.git synced 2025-07-23 05:18:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

javadoc

Browse source
This commit is contained in:
Vincent Behar 2011-07-06 14:08:49 +02:00
parent c52cf7584c
commit f31ed28129
6 changed files with 118 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

15
src/main/java/org/rundeck/api/RundeckClient.java
View file

@ -38,7 +38,20 @@ import org.rundeck.api.util.OptionsBuilder;
import org.rundeck.api.util.ParametersUtil;
/**
* Main entry point to talk to a RunDeck instance
* Main entry point to talk to a RunDeck instance.<br>
* Usage : <br>
* <code>
* <pre>
* RundeckClient rundeck = new RundeckClient("http://localhost:4440", "admin", "admin");
* List&lt;RundeckJob&gt; jobs = rundeck.getJobs();
*
* RundeckJob job = rundeck.findJob("my-project", "main-group/sub-group", "job-name");
* RundeckExecution execution = rundeck.triggerJob(job.getId(),
* new OptionsBuilder().addOption("version", "1.2.0").toProperties());
*
* List&lt;RundeckExecution&gt; runningExecutions = rundeck.getRunningExecutions("my-project");
* </pre>
* </code>
*
* @author Vincent Behar
*/

20
src/main/java/org/rundeck/api/domain/package-info.java Normal file
View file

@ -0,0 +1,20 @@
/*
* Copyright 2011 Vincent Behar
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Domain classes that are returned to the client of the API.
*/
package org.rundeck.api.domain;

20
src/main/java/org/rundeck/api/package-info.java Normal file
View file

@ -0,0 +1,20 @@
/*
* Copyright 2011 Vincent Behar
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Java client for the RunDeck API.
*/
package org.rundeck.api;

20
src/main/java/org/rundeck/api/parser/package-info.java Normal file
View file

@ -0,0 +1,20 @@
/*
* Copyright 2011 Vincent Behar
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Internal parsers for parsing the RunDeck responses.
*/
package org.rundeck.api.parser;

20
src/main/java/org/rundeck/api/util/package-info.java Normal file
View file

@ -0,0 +1,20 @@
/*
* Copyright 2011 Vincent Behar
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Some utility classes, and builders that can be used by clients of the API.
*/
package org.rundeck.api.util;

24
src/main/javadoc/overview.html Normal file
View file

@ -0,0 +1,24 @@
<!--
Copyright 2011 Vincent Behar
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>RunDeck API - Java Client</title>
</head>
<body>
<p>See the documentation of the <a href="org/rundeck/api/RundeckClient.html">RundeckClient</a> class (main entry point of the API).</p>
</body>
</html>