InstanceReader (Payara Project 6.2023.2 API)

All Superinterfaces:

BaseReader

All Known Implementing Classes:

InstanceReaderImpl
```
public interface InstanceReader
extends BaseReader
```
Provides instance information relavant to Load balancer tier.

Author:

Satish Viswanatham

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDisableTimeoutInMinutes()`	This is used in quicescing.
`boolean`	`getLbEnabled()`	Returns if the server is enabled in the load balancer or not.
`String`	`getListeners()`	Enlists both http and https listeners of this server instance It will be form "http:: https::"
`String`	`getName()`	Return server instance's name.
`String`	`getWeight()`	For weighted round robin gets the weight.

Methods inherited from interface org.glassfish.loadbalancer.admin.cli.reader.api.BaseReader
accept

- Method Detail
  - getName
```
String getName()
        throws LbReaderException
```
    Return server instance's name.
    
    Returns:
    
    String instance' name
    
    Throws:
    
    LbReaderException
  - getLbEnabled
```
boolean getLbEnabled()
              throws LbReaderException
```
    Returns if the server is enabled in the load balancer or not.
    
    Returns:
    
    boolean true if enabled in LB; false if disabled
    
    Throws:
    
    LbReaderException
  - getDisableTimeoutInMinutes
```
String getDisableTimeoutInMinutes()
                           throws LbReaderException
```
    This is used in quicescing. Timeouts after this interval and disables the instance in the load balancer.
    
    Returns:
    
    String Disable time out in minutes
    
    Throws:
    
    LbReaderException
  - getListeners
```
String getListeners()
             throws LbReaderException
```
    Enlists both http and https listeners of this server instance It will be form "http:: https::"
    
    Returns:
    
    String Listener(s) info.
    
    Throws:
    
    LbReaderException
  - getWeight
```
String getWeight()
          throws LbReaderException
```
    For weighted round robin gets the weight. Default value is 100
    
    Returns:
    
    String Weight
    
    Throws:
    
    LbReaderException