Cloud42BaseService (Cloud42 1.2.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.jw.cloud42.webservice
Class Cloud42BaseService

java.lang.Object
  de.jw.cloud42.webservice.Cloud42BaseService

public class Cloud42BaseService
extends java.lang.Object
extends java.lang.Object

Wrapper around Cloud42BaseFunctions to provide the base functions as a stateless web service. See there for a more detailed method reference.

Author:: fbitzer

Constructor Summary
`Cloud42BaseService()`

Method Summary
`boolean`	`addPermission(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String groupname, java.lang.String protocol, int portFrom, int portTo, java.lang.String cidrIp)` Wraps `Cloud42BaseFunctions.addPermission(java.lang.String, java.lang.String, int, int, java.lang.String)`.
`boolean`	`addPermissionSecGroup(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String groupname, java.lang.String secGroupName, java.lang.String secGroupOwnerId)` Wraps `Cloud42BaseFunctions.addPermission(java.lang.String, java.lang.String, java.lang.String)`.
`com.xerox.amazonws.ec2.KeyPairInfo`	`createKeypair(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String name)` Wraps `Cloud42BaseFunctions.createKeypair(java.lang.String)`.
`boolean`	`createSecurityGroup(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String name, java.lang.String description)` Wraps `Cloud42BaseFunctions.createSecurityGroup(java.lang.String, java.lang.String)`.
`boolean`	`deleteKeypair(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String name)` Wraps `Cloud42BaseFunctions.deleteKeypair(java.lang.String)`.
`boolean`	`deleteSecurityGroup(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String name)` Wraps `Cloud42BaseFunctions.deleteSecurityGroup(java.lang.String)`.
`boolean`	`deregisterImage(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String imageId)` Wraps `Cloud42BaseFunctions.deregisterImage(java.lang.String)`.
`Instance`	`describeInstance(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String instanceId)` Wraps `Cloud42BaseFunctions.describeInstance(java.lang.String)`.
`com.xerox.amazonws.ec2.KeyPairInfo`	`describeKeypair(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String name)` Wraps `Cloud42BaseFunctions.describeKeypair(java.lang.String)`.
`Cloud42GroupDescription`	`describeSecurityGroup(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String name)` Wraps `Cloud42BaseFunctions.describeSecurityGroup(java.lang.String)`.
`java.lang.String`	`getConsoleOutput(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String instanceId)` Wraps `Cloud42BaseFunctions.getConsoleOutput(java.lang.String)`.
`com.xerox.amazonws.ec2.AvailabilityZone[]`	`listAvailabilityZones(AwsCredentials credentials, java.lang.String regionUrl)` Wraps `Cloud42BaseFunctions.listAvailabilityZones()`.
`com.xerox.amazonws.ec2.ImageDescription[]`	`listImages(AwsCredentials credentials, java.lang.String regionUrl, boolean all)` Wraps `Cloud42BaseFunctions.listImages(boolean)`.
`Instance[]`	`listInstances(AwsCredentials credentials, java.lang.String regionUrl)` Wraps `Cloud42BaseFunctions.listInstances()`.
`com.xerox.amazonws.ec2.KeyPairInfo[]`	`listKeypairs(AwsCredentials credentials, java.lang.String regionUrl)` Wraps `Cloud42BaseFunctions.listKeypairs()`.
`com.xerox.amazonws.ec2.RegionInfo[]`	`listRegions(AwsCredentials credentials)` Wraps `Cloud42BaseFunctions.listRegions()`.
`Cloud42GroupDescription[]`	`listSecurityGroups(AwsCredentials credentials, java.lang.String regionUrl)` Wraps `Cloud42BaseFunctions.listSecurityGroups()`.
`void`	`rebootInstance(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String instanceId)` Wraps `Cloud42BaseFunctions.rebootInstance(java.lang.String)`.
`java.lang.String`	`registerImage(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String location)` Wraps `Cloud42BaseFunctions.registerImage(java.lang.String)`.
`boolean`	`removePermission(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String groupname, java.lang.String protocol, int portFrom, int portTo, java.lang.String cidrIp)` Wraps `Cloud42BaseFunctions.removePermission(java.lang.String, java.lang.String, int, int, java.lang.String)`.
`boolean`	`removePermissionSecGroup(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String groupname, java.lang.String secGroupName, java.lang.String secGroupOwnerId)` Wraps `Cloud42BaseFunctions.removePermission(java.lang.String, java.lang.String, java.lang.String)`.
`Instance[]`	`runInstance(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, java.lang.String userData, java.lang.String instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)` Wraps `Cloud42BaseFunctions.runInstance(java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)` Parameter instanceType is passed as String for compatibility reasons.
`Instance[]`	`runInstanceBlocking(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, java.lang.String userData, java.lang.String instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)` Wraps `Cloud42BaseFunctions.runInstanceBlocking(java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)` Parameter instanceType is passed as String for compatibility reasons.
`Instance[]`	`runInstanceBlockingWithBinary(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] binaryUserData, java.lang.String instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)` Wraps `Cloud42BaseFunctions.runInstanceBlocking(java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)` Provides possibility to attach binary data at instance startup.
`Instance[]`	`runInstanceWithBinary(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] binaryUserData, java.lang.String instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)` Wraps `Cloud42BaseFunctions.runInstance(java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)` Provides possibility to attach binary data at instance startup.
`com.xerox.amazonws.ec2.TerminatingInstanceDescription[]`	`stopAllInstances(AwsCredentials credentials, java.lang.String regionUrl)` Wraps `Cloud42BaseFunctions.stopAllInstances()`.
`com.xerox.amazonws.ec2.TerminatingInstanceDescription`	`stopInstance(AwsCredentials credentials, java.lang.String regionUrl, java.lang.String instanceId)` Wraps `Cloud42BaseFunctions.stopInstance(java.lang.String)`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Cloud42BaseService

public Cloud42BaseService()

Method Detail

listRegions

public com.xerox.amazonws.ec2.RegionInfo[] listRegions(AwsCredentials credentials)

Wraps Cloud42BaseFunctions.listRegions().

See Also:: Cloud42BaseFunctions.listRegions()

listImages

public com.xerox.amazonws.ec2.ImageDescription[] listImages(AwsCredentials credentials,
                                                            java.lang.String regionUrl,
                                                            boolean all)

Wraps Cloud42BaseFunctions.listImages(boolean).

See Also:: Cloud42BaseFunctions.listImages(boolean)

runInstance

public Instance[] runInstance(AwsCredentials credentials,
                              java.lang.String regionUrl,
                              java.lang.String imageId,
                              java.lang.String[] groups,
                              java.lang.String keyName,
                              java.lang.String userData,
                              java.lang.String instanceType,
                              int count,
                              java.lang.String availabilityZone,
                              java.lang.String kernelId,
                              java.lang.String ramdiskId)

Wraps

Cloud42BaseFunctions.runInstance(java.lang.String imageId, 
                        java.lang.String[] groups, 
                        java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, 
                        int count,
                        java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)

Parameter instanceType is passed as String for compatibility reasons. The official EC2 types are supported. See http://www.amazon.com/Instances-EC2-AWS/b?ie=UTF8&node=370375011.

Parameters:: regionUrl - is the URL of the AWS region to use as String, e.g. "ec2.eu-west-1.amazonaws.com"; instanceType - possible values are m1.small, m1.large, m1.xlarge, c1.medium, c1.xlarge
See Also:: Cloud42BaseFunctions.runInstance(java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)

runInstanceWithBinary

public Instance[] runInstanceWithBinary(AwsCredentials credentials,
                                        java.lang.String regionUrl,
                                        java.lang.String imageId,
                                        java.lang.String[] groups,
                                        java.lang.String keyName,
                                        byte[] binaryUserData,
                                        java.lang.String instanceType,
                                        int count,
                                        java.lang.String availabilityZone,
                                        java.lang.String kernelId,
                                        java.lang.String ramdiskId)

Wraps

Cloud42BaseFunctions.runInstance(java.lang.String imageId, 
                        java.lang.String[] groups, 
                        java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, 
                        int count,
                        java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)

Provides possibility to attach binary data at instance startup.
Parameter instanceType is passed as String for compatibility reasons. The official EC2 types are supported. See http://www.amazon.com/Instances-EC2-AWS/b?ie=UTF8&node=370375011.

Parameters:: instanceType - possible values are m1.small, m1.large, m1.xlarge, c1.medium, c1.xlarge; binaryUserData - Binary data to attach to instance (watch for limited file size!).
See Also:: Cloud42BaseFunctions.runInstance(java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)

runInstanceBlockingWithBinary

public Instance[] runInstanceBlockingWithBinary(AwsCredentials credentials,
                                                java.lang.String regionUrl,
                                                java.lang.String imageId,
                                                java.lang.String[] groups,
                                                java.lang.String keyName,
                                                byte[] binaryUserData,
                                                java.lang.String instanceType,
                                                int count,
                                                java.lang.String availabilityZone,
                                                java.lang.String kernelId,
                                                java.lang.String ramdiskId)

Wraps

Cloud42BaseFunctions.runInstanceBlocking(java.lang.String imageId, 
                        java.lang.String[] groups, 
                        java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, 
                        int count,
                        java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)

Parameters:: instanceType - possible values are m1.small, m1.large, m1.xlarge, c1.medium, c1.xlarge; binaryUserData - Binary data to attach to instance (watch for limited file size!).
See Also:: Cloud42BaseFunctions.runInstanceBlocking(java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)

runInstanceBlocking

public Instance[] runInstanceBlocking(AwsCredentials credentials,
                                      java.lang.String regionUrl,
                                      java.lang.String imageId,
                                      java.lang.String[] groups,
                                      java.lang.String keyName,
                                      java.lang.String userData,
                                      java.lang.String instanceType,
                                      int count,
                                      java.lang.String availabilityZone,
                                      java.lang.String kernelId,
                                      java.lang.String ramdiskId)

Wraps

Cloud42BaseFunctions.runInstanceBlocking(java.lang.String imageId, 
                        java.lang.String[] groups, 
                        java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, 
                        int count,
                        java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)

Parameter instanceType is passed as String for compatibility reasons. The official EC2 types are supported. See http://www.amazon.com/Instances-EC2-AWS/b?ie=UTF8&node=370375011.

Parameters:: regionUrl - is the URL of the AWS region to use as String, e.g. "ec2.eu-west-1.amazonaws.com"; instanceType - possible values are m1.small, m1.large, m1.xlarge, c1.medium, c1.xlarge
See Also:: Cloud42BaseFunctions.runInstanceBlocking(java.lang.String imageId, java.lang.String[] groups, java.lang.String keyName, byte[] userData, com.xerox.amazonws.ec2.InstanceType instanceType, int count, java.lang.String availabilityZone, java.lang.String kernelId, java.lang.String ramdiskId)

describeInstance

public Instance describeInstance(AwsCredentials credentials,
                                 java.lang.String regionUrl,
                                 java.lang.String instanceId)

Wraps Cloud42BaseFunctions.describeInstance(java.lang.String).

See Also:: Cloud42BaseFunctions.describeInstance(java.lang.String)

stopInstance

public com.xerox.amazonws.ec2.TerminatingInstanceDescription stopInstance(AwsCredentials credentials,
                                                                          java.lang.String regionUrl,
                                                                          java.lang.String instanceId)

Wraps Cloud42BaseFunctions.stopInstance(java.lang.String).

See Also:: Cloud42BaseFunctions.stopInstance(java.lang.String)

stopAllInstances

public com.xerox.amazonws.ec2.TerminatingInstanceDescription[] stopAllInstances(AwsCredentials credentials,
                                                                                java.lang.String regionUrl)

Wraps Cloud42BaseFunctions.stopAllInstances().

See Also:: Cloud42BaseFunctions.stopAllInstances()

rebootInstance

public void rebootInstance(AwsCredentials credentials,
                           java.lang.String regionUrl,
                           java.lang.String instanceId)

Wraps Cloud42BaseFunctions.rebootInstance(java.lang.String).

See Also:: Cloud42BaseFunctions.rebootInstance(java.lang.String)

listInstances

public Instance[] listInstances(AwsCredentials credentials,
                                java.lang.String regionUrl)

Wraps Cloud42BaseFunctions.listInstances().

See Also:: Cloud42BaseFunctions.listInstances()

createSecurityGroup

public boolean createSecurityGroup(AwsCredentials credentials,
                                   java.lang.String regionUrl,
                                   java.lang.String name,
                                   java.lang.String description)

Wraps Cloud42BaseFunctions.createSecurityGroup(java.lang.String, java.lang.String).

See Also:: Cloud42BaseFunctions.createSecurityGroup(java.lang.String, java.lang.String)

deleteSecurityGroup

public boolean deleteSecurityGroup(AwsCredentials credentials,
                                   java.lang.String regionUrl,
                                   java.lang.String name)

Wraps Cloud42BaseFunctions.deleteSecurityGroup(java.lang.String).

See Also:: Cloud42BaseFunctions.deleteSecurityGroup(java.lang.String)

listSecurityGroups

public Cloud42GroupDescription[] listSecurityGroups(AwsCredentials credentials,
                                                    java.lang.String regionUrl)

Wraps Cloud42BaseFunctions.listSecurityGroups().

See Also:: Cloud42BaseFunctions.listSecurityGroups()

describeSecurityGroup

public Cloud42GroupDescription describeSecurityGroup(AwsCredentials credentials,
                                                     java.lang.String regionUrl,
                                                     java.lang.String name)

Wraps Cloud42BaseFunctions.describeSecurityGroup(java.lang.String).

See Also:: Cloud42BaseFunctions.describeSecurityGroup(java.lang.String)

addPermission

public boolean addPermission(AwsCredentials credentials,
                             java.lang.String regionUrl,
                             java.lang.String groupname,
                             java.lang.String protocol,
                             int portFrom,
                             int portTo,
                             java.lang.String cidrIp)

Wraps

Cloud42BaseFunctions.addPermission(java.lang.String, java.lang.String, 
 int, int, java.lang.String)

See Also:: Cloud42BaseFunctions.addPermission(java.lang.String, java.lang.String, int, int, java.lang.String)

addPermissionSecGroup

public boolean addPermissionSecGroup(AwsCredentials credentials,
                                     java.lang.String regionUrl,
                                     java.lang.String groupname,
                                     java.lang.String secGroupName,
                                     java.lang.String secGroupOwnerId)

Wraps

Cloud42BaseFunctions.addPermission(java.lang.String, java.lang.String, 
 java.lang.String)

See Also:: Cloud42BaseFunctions.addPermission(java.lang.String, java.lang.String, java.lang.String)

removePermission

public boolean removePermission(AwsCredentials credentials,
                                java.lang.String regionUrl,
                                java.lang.String groupname,
                                java.lang.String protocol,
                                int portFrom,
                                int portTo,
                                java.lang.String cidrIp)

Wraps

Cloud42BaseFunctions.removePermission(java.lang.String, java.lang.String, 
 int, int, java.lang.String)

See Also:: Cloud42BaseFunctions.removePermission(java.lang.String, java.lang.String, int, int, java.lang.String)

removePermissionSecGroup

public boolean removePermissionSecGroup(AwsCredentials credentials,
                                        java.lang.String regionUrl,
                                        java.lang.String groupname,
                                        java.lang.String secGroupName,
                                        java.lang.String secGroupOwnerId)

Wraps

Cloud42BaseFunctions.removePermission(java.lang.String, java.lang.String, 
  java.lang.String)

See Also:: Cloud42BaseFunctions.removePermission(java.lang.String, java.lang.String, java.lang.String)

registerImage

public java.lang.String registerImage(AwsCredentials credentials,
                                      java.lang.String regionUrl,
                                      java.lang.String location)

Wraps Cloud42BaseFunctions.registerImage(java.lang.String).

See Also:: Cloud42BaseFunctions.registerImage(java.lang.String)

deregisterImage

public boolean deregisterImage(AwsCredentials credentials,
                               java.lang.String regionUrl,
                               java.lang.String imageId)

Wraps Cloud42BaseFunctions.deregisterImage(java.lang.String).

See Also:: Cloud42BaseFunctions.deregisterImage(java.lang.String)

createKeypair

public com.xerox.amazonws.ec2.KeyPairInfo createKeypair(AwsCredentials credentials,
                                                        java.lang.String regionUrl,
                                                        java.lang.String name)

Wraps Cloud42BaseFunctions.createKeypair(java.lang.String).

See Also:: Cloud42BaseFunctions.createKeypair(java.lang.String)

deleteKeypair

public boolean deleteKeypair(AwsCredentials credentials,
                             java.lang.String regionUrl,
                             java.lang.String name)

Wraps Cloud42BaseFunctions.deleteKeypair(java.lang.String).

See Also:: Cloud42BaseFunctions.deleteKeypair(java.lang.String)

listKeypairs

public com.xerox.amazonws.ec2.KeyPairInfo[] listKeypairs(AwsCredentials credentials,
                                                         java.lang.String regionUrl)

Wraps Cloud42BaseFunctions.listKeypairs().

See Also:: Cloud42BaseFunctions.listKeypairs()

describeKeypair

public com.xerox.amazonws.ec2.KeyPairInfo describeKeypair(AwsCredentials credentials,
                                                          java.lang.String regionUrl,
                                                          java.lang.String name)

Wraps Cloud42BaseFunctions.describeKeypair(java.lang.String).

See Also:: Cloud42BaseFunctions.describeKeypair(java.lang.String)

listAvailabilityZones

public com.xerox.amazonws.ec2.AvailabilityZone[] listAvailabilityZones(AwsCredentials credentials,
                                                                       java.lang.String regionUrl)

Wraps Cloud42BaseFunctions.listAvailabilityZones().

See Also:: Cloud42BaseFunctions.listAvailabilityZones()

getConsoleOutput

public java.lang.String getConsoleOutput(AwsCredentials credentials,
                                         java.lang.String regionUrl,
                                         java.lang.String instanceId)

Wraps Cloud42BaseFunctions.getConsoleOutput(java.lang.String).

Returns:: a String value containing the console output.
See Also:: Cloud42BaseFunctions.getConsoleOutput(java.lang.String)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.jw.cloud42.webservice Class Cloud42BaseService

Cloud42BaseService

listRegions

listImages

runInstance

runInstanceWithBinary

runInstanceBlockingWithBinary

runInstanceBlocking

describeInstance

stopInstance

stopAllInstances

rebootInstance

listInstances

createSecurityGroup

deleteSecurityGroup

listSecurityGroups

describeSecurityGroup

addPermission

addPermissionSecGroup

removePermission

removePermissionSecGroup

registerImage

deregisterImage

createKeypair

deleteKeypair

listKeypairs

describeKeypair

listAvailabilityZones

getConsoleOutput

de.jw.cloud42.webservice
Class Cloud42BaseService