SolutionsMXBean (Decision Server Insights Java API)

@MXBean
public interface SolutionsMXBean

MBean to manage solutions.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String MXBEAN_OBJECT_NAME
The object name by which a JMX client can find the SolutionsMXBean

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`MXBEAN_OBJECT_NAME` The object name by which a JMX client can find the SolutionsMXBean

Method Summary

Methods
Modifier and Type	Method and Description
`SolutionStatus`	`activateSolution(java.lang.String solutionName)` Make a full version of a solution current
`SolutionStatus`	`deploySolution(java.lang.String filename, boolean exportOnly, boolean enableOnly, boolean forceEnable, boolean redeploy)` Deploys a version of a solution.
`java.util.List<java.lang.String>`	`getProperties(java.lang.String solutionName)` Returns a string list of all property names for the given solution
`java.lang.String`	`getProperty(java.lang.String solutionName, java.lang.String propertyName)` Returns the property value in the solution.
`java.util.List<Solution>`	`getSolutions()` Returns the list of all solutions deployed on this server.
`java.lang.String`	`getSolutionVersion(java.lang.String solutionName)` Returns the current version for the solution
`boolean`	`isDeployed(java.lang.String solutionName)` Returns true if the solution is currently deployed
`boolean`	`isReady(java.lang.String solutionName)` Returns true if solution is Ready
`SolutionStatus`	`redeploySolution(java.lang.String filename, boolean enableOnly)` Redeploy the same version of a solution.
`SolutionStatus`	`revertSolution(java.lang.String solutionName)` Revert a solution to its last known state
`boolean`	`setProperties(java.lang.String solutionName, java.util.Map<java.lang.String,java.lang.String> properties)` Sets a number of property values in the solution.
`boolean`	`setProperty(java.lang.String solutionName, java.lang.String propertyName, java.lang.String propertyValue)` Sets the property value in the solution.
`SolutionStatus`	`stopSolution(java.lang.String solutionName)` Stop the current version of a solution
`SolutionStatus`	`undeploySolution(java.lang.String solutionName)` Undeploy a version of a solution.

- Field Detail
  - MXBEAN_OBJECT_NAME
```
static final java.lang.String MXBEAN_OBJECT_NAME
```
    The object name by which a JMX client can find the SolutionsMXBean
    
    See Also:
    Constant Field Values
- Method Detail
  - deploySolution
```
SolutionStatus deploySolution(java.lang.String filename,
                            boolean exportOnly,
                            boolean enableOnly,
                            boolean forceEnable,
                            boolean redeploy)
```
    Deploys a version of a solution. The version could be a full or partial version. If it is a partial version, then the parent full version must already be deployed.
    
    Parameters:
    filename - the name of the solution file, on the server
    exportOnly - if true, deploy the bundle but don't activate in server.xml
    enableOnly - if true, only update server.xml
    forceEnable - if true, update server.xml even if esa already installed
    redeploy - if true, redeploy the same version that already exists (non-production only)
    
    Returns:
    status
  - getSolutions
```
java.util.List<Solution> getSolutions()
```
    Returns the list of all solutions deployed on this server.
    
    Returns:
    tabular data for each solution.
  - undeploySolution
```
SolutionStatus undeploySolution(java.lang.String solutionName)
```
    Undeploy a version of a solution. The version could be a full or partial version. If it is a full version, then any child versions will also be undeployed.
    
    Parameters:
    solutionName - the symbolic name of the solution to undeploy. This is not the global name of the solution but is instead the symbolic name of the specific version
    
    Returns:
    status
  - revertSolution
```
SolutionStatus revertSolution(java.lang.String solutionName)
```
    Revert a solution to its last known state
    
    Parameters:
    solutionName - the global name of the solution to revert
    
    Returns:
    status
  - redeploySolution
```
SolutionStatus redeploySolution(java.lang.String filename,
                              boolean enableOnly)
```
    Redeploy the same version of a solution. The solution replaces the solution of the same version.
    
    Parameters:
    filename - the name of the solution file, on the server
    enableOnly - if true, only update server.xml
    
    Returns:
    status
  - activateSolution
```
SolutionStatus activateSolution(java.lang.String solutionName)
```
    Make a full version of a solution current
    
    Parameters:
    solutionName - the symbolic name of the full version of the solution to activate
    
    Returns:
    status
  - stopSolution
```
SolutionStatus stopSolution(java.lang.String solutionName)
```
    Stop the current version of a solution
    
    Parameters:
    solutionName - the symbolic name of the solution to stop
    
    Returns:
    status
  - getProperty
```
java.lang.String getProperty(java.lang.String solutionName,
                           java.lang.String propertyName)
                             throws java.lang.IllegalArgumentException
```
    Returns the property value in the solution. The solution name should be the name of the solution, not a specific version of the solution.
    
    Throws:
    
    java.lang.IllegalArgumentException
    Parameters:
    solutionName - the name of the solution
    propertyName - the name of the property
    
    Returns:
    the property value
  - setProperty
```
boolean setProperty(java.lang.String solutionName,
                  java.lang.String propertyName,
                  java.lang.String propertyValue)
                    throws java.lang.IllegalArgumentException
```
    Sets the property value in the solution. The property value will be set on all servers.
    
    Throws:
    
    java.lang.IllegalArgumentException
    Parameters:
    solutionName - the name of the solution
    propertyName - the name of the property
    propertyValue - the value of the property to set
    
    Returns:
    - true if the call succeeded
  - setProperties
```
boolean setProperties(java.lang.String solutionName,
                    java.util.Map<java.lang.String,java.lang.String> properties)
```
    Sets a number of property values in the solution. The property values will be set on all servers.
    
    Parameters:
    solutionName - the name of the solution
    properties - the map containing the properties
    
    Returns:
    true if the call succeeded
  - getProperties
```
java.util.List<java.lang.String> getProperties(java.lang.String solutionName)
```
    Returns a string list of all property names for the given solution
    
    Parameters:
    solutionName - the name of the solution
    
    Returns:
    the list of property names
  - getSolutionVersion
```
java.lang.String getSolutionVersion(java.lang.String solutionName)
```
    Returns the current version for the solution
    
    Parameters:
    solutionName - the name of the solution
    
    Returns:
    the symbolic name of the current solution version
  - isDeployed
```
boolean isDeployed(java.lang.String solutionName)
```
    Returns true if the solution is currently deployed
    
    Parameters:
    solutionName - the name of the solution
  - isReady
```
boolean isReady(java.lang.String solutionName)
```
    Returns true if solution is Ready
    
    Parameters:
    solutionName -
    
    Returns:
    true if the solution is ready

MXBEAN_OBJECT_NAME

deploySolution

getSolutions

undeploySolution

revertSolution

redeploySolution

activateSolution

stopSolution

getProperty

setProperty

setProperties

getProperties

getSolutionVersion

isDeployed

isReady