SsoServerInstance (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.monitoring.SsoServerInstance

All Implemented Interfaces:

SsoServerInstanceMBean, Serializable

Direct Known Subclasses:

SsoServerInstanceImpl
```
public class SsoServerInstance
extends Object
implements SsoServerInstanceMBean, Serializable
```
The class is used for implementing the "SsoServerInstance" group. The group is defined with the following oid: 1.3.6.1.4.1.42.2.230.3.1.1.2.1.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`SsoServerConfigStoreType` Variable for storing the value of "SsoServerConfigStoreType".
`protected String`	`SsoServerHostname` Variable for storing the value of "SsoServerHostname".
`protected String`	`SsoServerId` Variable for storing the value of "SsoServerId".
`protected Integer`	`SsoServerMemberOfSite` Variable for storing the value of "SsoServerMemberOfSite".
`protected Integer`	`SsoServerPort` Variable for storing the value of "SsoServerPort".
`protected TableSsoServerRealmTable`	`SsoServerRealmTable` Variable for storing the value of "SsoServerRealmTable".
`protected Byte[]`	`SsoServerStartDate` Variable for storing the value of "SsoServerStartDate".

Constructor Summary

Constructors
Constructor and Description
`SsoServerInstance(com.sun.management.snmp.agent.SnmpMib myMib)` Constructor for the "SsoServerInstance" group.
`SsoServerInstance(com.sun.management.snmp.agent.SnmpMib myMib, MBeanServer server)` Constructor for the "SsoServerInstance" group.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TableSsoServerRealmTable`	`accessSsoServerRealmTable()` Access the "SsoServerRealmTable" variable.
`String`	`getSsoServerConfigStoreType()` Getter for the "SsoServerConfigStoreType" variable.
`String`	`getSsoServerHostname()` Getter for the "SsoServerHostname" variable.
`String`	`getSsoServerId()` Getter for the "SsoServerId" variable.
`Integer`	`getSsoServerMemberOfSite()` Getter for the "SsoServerMemberOfSite" variable.
`Integer`	`getSsoServerPort()` Getter for the "SsoServerPort" variable.
`SsoServerRealmEntryMBean[]`	`getSsoServerRealmTable()` Access the "SsoServerRealmTable" variable as a bean indexed property.
`Byte[]`	`getSsoServerStartDate()` Getter for the "SsoServerStartDate" variable.

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

- Field Detail
  - SsoServerRealmTable
```
protected TableSsoServerRealmTable SsoServerRealmTable
```
    Variable for storing the value of "SsoServerRealmTable". The variable is identified by: "1.3.6.1.4.1.42.2.230.3.1.1.2.1.9". "OpenSSO Server Realms"
  - SsoServerConfigStoreType
```
protected String SsoServerConfigStoreType
```
    Variable for storing the value of "SsoServerConfigStoreType". The variable is identified by: "1.3.6.1.4.1.42.2.230.3.1.1.2.1.6". "Type of config store : remote | embedded"
  - SsoServerStartDate
```
protected Byte[] SsoServerStartDate
```
    Variable for storing the value of "SsoServerStartDate". The variable is identified by: "1.3.6.1.4.1.42.2.230.3.1.1.2.1.5". In the SNMP MIB, this is defined as a fixed length string of size 8. "Date this server was started"
  - SsoServerMemberOfSite
```
protected Integer SsoServerMemberOfSite
```
    Variable for storing the value of "SsoServerMemberOfSite". The variable is identified by: "1.3.6.1.4.1.42.2.230.3.1.1.2.1.4". "SiteID of which this server is a member"
  - SsoServerPort
```
protected Integer SsoServerPort
```
    Variable for storing the value of "SsoServerPort". The variable is identified by: "1.3.6.1.4.1.42.2.230.3.1.1.2.1.3". "Port number of this server"
  - SsoServerHostname
```
protected String SsoServerHostname
```
    Variable for storing the value of "SsoServerHostname". The variable is identified by: "1.3.6.1.4.1.42.2.230.3.1.1.2.1.2". "Hostname of this server"
  - SsoServerId
```
protected String SsoServerId
```
    Variable for storing the value of "SsoServerId". The variable is identified by: "1.3.6.1.4.1.42.2.230.3.1.1.2.1.1". "ServerID of this server"
- Constructor Detail
  - SsoServerInstance
```
public SsoServerInstance(com.sun.management.snmp.agent.SnmpMib myMib)
```
    Constructor for the "SsoServerInstance" group. If the group contains a table, the entries created through an SNMP SET will not be registered in Java DMK.
  - SsoServerInstance
```
public SsoServerInstance(com.sun.management.snmp.agent.SnmpMib myMib,
                         MBeanServer server)
```
    Constructor for the "SsoServerInstance" group. If the group contains a table, the entries created through an SNMP SET will be AUTOMATICALLY REGISTERED in Java DMK.
- Method Detail
  - accessSsoServerRealmTable
```
public TableSsoServerRealmTable accessSsoServerRealmTable()
                                                   throws com.sun.management.snmp.SnmpStatusException
```
    Access the "SsoServerRealmTable" variable.
    
    Specified by:
    
    accessSsoServerRealmTable in interface SsoServerInstanceMBean
    
    Throws:
    
    com.sun.management.snmp.SnmpStatusException
  - getSsoServerRealmTable
```
public SsoServerRealmEntryMBean[] getSsoServerRealmTable()
                                                  throws com.sun.management.snmp.SnmpStatusException
```
    Access the "SsoServerRealmTable" variable as a bean indexed property.
    
    Throws:
    
    com.sun.management.snmp.SnmpStatusException
  - getSsoServerConfigStoreType
```
public String getSsoServerConfigStoreType()
                                   throws com.sun.management.snmp.SnmpStatusException
```
    Getter for the "SsoServerConfigStoreType" variable.
    
    Specified by:
    
    getSsoServerConfigStoreType in interface SsoServerInstanceMBean
    
    Throws:
    
    com.sun.management.snmp.SnmpStatusException
  - getSsoServerStartDate
```
public Byte[] getSsoServerStartDate()
                             throws com.sun.management.snmp.SnmpStatusException
```
    Getter for the "SsoServerStartDate" variable.
    
    Specified by:
    
    getSsoServerStartDate in interface SsoServerInstanceMBean
    
    Throws:
    
    com.sun.management.snmp.SnmpStatusException
  - getSsoServerMemberOfSite
```
public Integer getSsoServerMemberOfSite()
                                 throws com.sun.management.snmp.SnmpStatusException
```
    Getter for the "SsoServerMemberOfSite" variable.
    
    Specified by:
    
    getSsoServerMemberOfSite in interface SsoServerInstanceMBean
    
    Throws:
    
    com.sun.management.snmp.SnmpStatusException
  - getSsoServerPort
```
public Integer getSsoServerPort()
                         throws com.sun.management.snmp.SnmpStatusException
```
    Getter for the "SsoServerPort" variable.
    
    Specified by:
    
    getSsoServerPort in interface SsoServerInstanceMBean
    
    Throws:
    
    com.sun.management.snmp.SnmpStatusException
  - getSsoServerHostname
```
public String getSsoServerHostname()
                            throws com.sun.management.snmp.SnmpStatusException
```
    Getter for the "SsoServerHostname" variable.
    
    Specified by:
    
    getSsoServerHostname in interface SsoServerInstanceMBean
    
    Throws:
    
    com.sun.management.snmp.SnmpStatusException
  - getSsoServerId
```
public String getSsoServerId()
                      throws com.sun.management.snmp.SnmpStatusException
```
    Getter for the "SsoServerId" variable.
    
    Specified by:
    
    getSsoServerId in interface SsoServerInstanceMBean
    
    Throws:
    
    com.sun.management.snmp.SnmpStatusException

Class SsoServerInstance

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SsoServerRealmTable

SsoServerConfigStoreType

SsoServerStartDate

SsoServerMemberOfSite

SsoServerPort

SsoServerHostname

SsoServerId

Constructor Detail

SsoServerInstance

SsoServerInstance

Method Detail

accessSsoServerRealmTable

getSsoServerRealmTable

getSsoServerConfigStoreType

getSsoServerStartDate

getSsoServerMemberOfSite

getSsoServerPort

getSsoServerHostname

getSsoServerId