RoleEnvironment (Microsoft Windows Azure Client API 0.4.2 API)

java.lang.Object
- com.microsoft.windowsazure.serviceruntime.RoleEnvironment

```
public final class RoleEnvironment
extends Object
```
Represents the Windows Azure environment in which an instance of a role is running.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addRoleEnvironmentChangedListener(RoleEnvironmentChangedListener listener)` Adds an event listener for the `Changed` event, which occurs after a configuration change has been applied to a role instance.
`static void`	`addRoleEnvironmentChangingListener(RoleEnvironmentChangingListener listener)` Adds an event listener for the `Changing` event, which occurs before a change to the service configuration is applied to the running instances of the role.
`static void`	`addRoleEnvironmentStoppingListener(RoleEnvironmentStoppingListener listener)` Adds an event listener for the `Stopping` event, which occurs wheen the role is stopping.
`static void`	`clearStatus()` Clears the status of the role instance.
`static Map<String,String>`	`getConfigurationSettings()` Retrieves the settings in the service configuration file.
`static RoleInstance`	`getCurrentRoleInstance()` Returns a `RoleInstance` object that represents the role instance in which this code is currently executing.
`static String`	`getDeploymentId()` Returns the deployment ID that uniquely identifies the deployment in which this role instance is running.
`static Map<String,LocalResource>`	`getLocalResources()` Retrieves the set of named local storage resources.
`static Map<String,Role>`	`getRoles()` Returns the set of `Role` objects defined for your service.
`static boolean`	`isAvailable()` Indicates whether the role instance is running in the Windows Azure environment.
`static boolean`	`isEmulated()` Indicates whether the role instance is running in the development fabric.
`static void`	`removeRoleEnvironmentChangedListener(RoleEnvironmentChangedListener listener)` Removes an event listener for the `Changed` event.
`static void`	`removeRoleEnvironmentChangingListener(RoleEnvironmentChangingListener listener)` Removes an event listener for the `Changing` event.
`static void`	`removeRoleEnvironmentStoppingListener(RoleEnvironmentStoppingListener listener)` Removes an event listener for the `Stopping` event.
`static void`	`requestRecycle()` Requests that the current role instance be stopped and restarted.
`static void`	`setStatus(RoleInstanceStatus status, Date expiration_utc)` Sets the status of the role instance.

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

- Method Detail
  - getCurrentRoleInstance
```
public static RoleInstance getCurrentRoleInstance()
```
    Returns a RoleInstance object that represents the role instance in which this code is currently executing.
    
    Returns:
    A RoleInstance object that represents the role instance in which this code is currently executing.
  - getDeploymentId
```
public static String getDeploymentId()
```
    Returns the deployment ID that uniquely identifies the deployment in which this role instance is running.
    
    Returns:
    A String object that represents the deployment ID.
  - isAvailable
```
public static boolean isAvailable()
```
    Indicates whether the role instance is running in the Windows Azure environment.
    
    Returns:
    true if this instance is running in the development fabric or in the Windows Azure environment in the cloud; otherwise, false.
  - isEmulated
```
public static boolean isEmulated()
```
    Indicates whether the role instance is running in the development fabric.
    
    Returns:
    true if this instance is running in the development fabric; otherwise, false.
  - getRoles
```
public static Map<String,Role> getRoles()
```
    Returns the set of Role objects defined for your service.
    Roles are defined in the service definition file.
    
    Returns:
    A java.util.Map object containing the set of Role objects that represent the roles defined for your service.
  - getConfigurationSettings
```
public static Map<String,String> getConfigurationSettings()
```
    Retrieves the settings in the service configuration file.
    A role's configuration settings are defined in the service definition file. Values for configuration settings are set in the service configuration file.
    
    Returns:
    A java.util.Map object containing the String objects that represent the configuration settings.
  - getLocalResources
```
public static Map<String,LocalResource> getLocalResources()
```
    Retrieves the set of named local storage resources.
    
    Returns:
    A java.util.Map object containing the String objects that represent the local storage resources.
  - requestRecycle
```
public static void requestRecycle()
```
    Requests that the current role instance be stopped and restarted.
    Before the role instance is recycled, the Windows Azure load balancer takes the role instance out of rotation. This ensures that no new requests are routed to the instance while it is restarting. A call to RequestRecycle initiates the normal shutdown cycle. Windows Azure raises the Stopping event and calls the OnStop method so that you can run the necessary code to prepare the instance to be recycled.
  - setStatus
```
public static void setStatus(RoleInstanceStatus status,
             Date expiration_utc)
```
    Sets the status of the role instance.
    An instance may indicate that it is in one of two states: Ready or Busy. If an instance's state is Ready, it is prepared to receive requests from the load balancer. If the instance's state is Busy, it will not receive requests from the load balancer.
    
    Parameters:
    status - A RoleInstanceStatus value that indicates whether the instance is ready or busy.
    expiration_utc - A java.util.Date value that specifies the expiration date and time of the status.
  - clearStatus
```
public static void clearStatus()
```
    Clears the status of the role instance.
    An instance may indicate that it has completed communicating status by calling this method.
  - addRoleEnvironmentChangedListener
```
public static void addRoleEnvironmentChangedListener(RoleEnvironmentChangedListener listener)
```
    Adds an event listener for the Changed event, which occurs after a configuration change has been applied to a role instance.
    A Changed event is encapsulated in a RoleEnvironmentChangedEvent object.
    
    Parameters:
    listener - A RoleEnvironmentChangedListener object that represents the event listener to add.
    See Also:
    removeRoleEnvironmentChangedListener(com.microsoft.windowsazure.serviceruntime.RoleEnvironmentChangedListener)
  - removeRoleEnvironmentChangedListener
```
public static void removeRoleEnvironmentChangedListener(RoleEnvironmentChangedListener listener)
```
    Removes an event listener for the Changed event.
    
    Parameters:
    listener - A RoleEnvironmentChangedListener object that represents the event listener to remove.
    See Also:
    addRoleEnvironmentChangedListener(com.microsoft.windowsazure.serviceruntime.RoleEnvironmentChangedListener)
  - addRoleEnvironmentChangingListener
```
public static void addRoleEnvironmentChangingListener(RoleEnvironmentChangingListener listener)
```
    Adds an event listener for the Changing event, which occurs before a change to the service configuration is applied to the running instances of the role.
    Service configuration changes are applied on-the-fly to running role instances. Configuration changes include changes to the service configuration changes and changes to the number of instances in the service.
    This event occurs after the new configuration file has been submitted to Windows Azure but before the changes have been applied to each running role instance. This event can be cancelled for a given instance to prevent the configuration change.
    Note that cancelling this event causes the instance to be automatically recycled. When the instance is recycled, the configuration change is applied when it restarts.
    A Changing event is encapsulated in a RoleEnvironmentChangingEvent object.
    
    Parameters:
    listener - A RoleEnvironmentChangingListener object that represents the event listener to add.
    See Also:
    removeRoleEnvironmentChangingListener(com.microsoft.windowsazure.serviceruntime.RoleEnvironmentChangingListener)
  - removeRoleEnvironmentChangingListener
```
public static void removeRoleEnvironmentChangingListener(RoleEnvironmentChangingListener listener)
```
    Removes an event listener for the Changing event.
    
    Parameters:
    listener - A RoleEnvironmentChangingListener object that represents the event listener to remove.
    See Also:
    addRoleEnvironmentChangingListener(com.microsoft.windowsazure.serviceruntime.RoleEnvironmentChangingListener)
  - addRoleEnvironmentStoppingListener
```
public static void addRoleEnvironmentStoppingListener(RoleEnvironmentStoppingListener listener)
```
    Adds an event listener for the Stopping event, which occurs wheen the role is stopping.
    
    Parameters:
    listener - A RoleEnvironmentStoppingListener object that represents the event listener to add.
    See Also:
    removeRoleEnvironmentStoppingListener(com.microsoft.windowsazure.serviceruntime.RoleEnvironmentStoppingListener)
  - removeRoleEnvironmentStoppingListener
```
public static void removeRoleEnvironmentStoppingListener(RoleEnvironmentStoppingListener listener)
```
    Removes an event listener for the Stopping event.
    
    Parameters:
    listener - A RoleEnvironmentStoppingListener object that represents the event listener to remove.
    See Also:
    addRoleEnvironmentStoppingListener(com.microsoft.windowsazure.serviceruntime.RoleEnvironmentStoppingListener)

/** 
* Copyright Microsoft Corporation 
* 
* 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. 
*/

Class RoleEnvironment

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCurrentRoleInstance

getDeploymentId

isAvailable

isEmulated

getRoles

getConfigurationSettings

getLocalResources

requestRecycle

setStatus

clearStatus

addRoleEnvironmentChangedListener

removeRoleEnvironmentChangedListener

addRoleEnvironmentChangingListener

removeRoleEnvironmentChangingListener

addRoleEnvironmentStoppingListener

removeRoleEnvironmentStoppingListener