EndpointProperties (Solace Messaging API for Java v10.28.1)

java.lang.Object
- com.solacesystems.jcsmp.EndpointProperties

```
public class EndpointProperties
extends Object
```
Endpoint properties used for provisioning durable endpoints, and for provisioning non-durable endpoints created through JCSMPSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps).

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESSTYPE_EXCLUSIVE` The first client to bind receives the messages.
`static int`	`ACCESSTYPE_NONEXCLUSIVE` Each client bound receives messages in a round-robin fashion.
`static int`	`DISCARD_NOTIFY_SENDER_OFF` Do not notify sender if a message fails to be enqueued to the endpoint.
`static int`	`DISCARD_NOTIFY_SENDER_ON` Notify sender if a message fails to be enqueued to the endpoint.
`static int`	`PERMISSION_CONSUME` Permission to consume messages from the endpoint.
`static int`	`PERMISSION_DELETE` Permission to delete an endpoint.
`static int`	`PERMISSION_MODIFY_TOPIC` Permission to modify the topic on a Topic endpoint.
`static int`	`PERMISSION_NONE` No permission on the endpoint.
`static int`	`PERMISSION_READ_ONLY` Permission to only read from an endpoint.

Constructor Summary

Constructors
Constructor and Description
`EndpointProperties()` EndpointProperties constructor using default values of null.
`EndpointProperties(Integer accessType, Integer maxMsgSize, Integer permission, Integer quota)` EndpointProperties constructor.
`EndpointProperties(Integer accessType, Integer maxMsgSize, Integer permission, Integer quota, Boolean respectsMsgTimeToLive)` EndpointProperties constructor.
`EndpointProperties(Integer accessType, Integer maxMsgSize, Integer permission, Integer quota, Boolean respectsMsgTimeToLive, Integer discardBehavior)` EndpointProperties constructor.
`EndpointProperties(Integer accessType, Integer maxMsgSize, Integer permission, Integer quota, Boolean respectsMsgTimeToLive, Integer discardBehavior, Integer maxMsgRedelivery)` EndpointProperties constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getAccessType()` Returns the access type for the endpoint.
`Integer`	`getDiscardBehavior()` Whether to notify sender if a message fails to be enqueued to the endpoint.
`Integer`	`getMaxMsgRedelivery()` Defines the maximum message redelivery count on the queue or topic endpoint.
`Integer`	`getMaxMsgSize()` Returns the maximum message size for the endpoint.
`Integer`	`getPermission()` Returns the permission for this endpoint.
`Integer`	`getQuota()` Returns the quota for the endpoint.
`Boolean`	`isRespectsMsgTTL()` The method returns whether the endpoint respects a message's Time-to-Live (TTL) value.
`void`	`setAccessType(Integer accessType)` Sets the access type for the endpoint.
`void`	`setDiscardBehavior(Integer discardBehavior)` If set, whether to notify sender if a message fails to be enqueued to the endpoint.
`void`	`setMaxMsgRedelivery(Integer maxMsgRedelivery)` Sets the maximum message redelivery count on the queue or topic endpoint.
`void`	`setMaxMsgSize(Integer maxMsgSize)` Sets the maximum message size for the endpoint.
`void`	`setPermission(Integer permission)` Sets the permissions for the endpoint.
`void`	`setQuota(Integer quota)` Sets the message spool quota for an endpoint.
`void`	`setRespectsMsgTTL(Boolean respectsMsgTimeToLive)` Whether the endpoint will respect messages' Time-to-Live values.

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

- Field Detail
  - PERMISSION_NONE
```
public static final int PERMISSION_NONE
```
    No permission on the endpoint.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_READ_ONLY
```
public static final int PERMISSION_READ_ONLY
```
    Permission to only read from an endpoint.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_CONSUME
```
public static final int PERMISSION_CONSUME
```
    Permission to consume messages from the endpoint. Includes permissions defined by EndpointProperties.PERMISSION_READ_ONLY
    
    See Also:
    
    Constant Field Values
  - PERMISSION_MODIFY_TOPIC
```
public static final int PERMISSION_MODIFY_TOPIC
```
    Permission to modify the topic on a Topic endpoint. Includes permissions defined by EndpointProperties.PERMISSION_CONSUME
    
    See Also:
    
    Constant Field Values
  - PERMISSION_DELETE
```
public static final int PERMISSION_DELETE
```
    Permission to delete an endpoint. Includes permissions defined by EndpointProperties.PERMISSION_MODIFY_TOPIC
    
    See Also:
    
    Constant Field Values
  - ACCESSTYPE_EXCLUSIVE
```
public static final int ACCESSTYPE_EXCLUSIVE
```
    The first client to bind receives the messages.
    
    See Also:
    
    Constant Field Values
  - ACCESSTYPE_NONEXCLUSIVE
```
public static final int ACCESSTYPE_NONEXCLUSIVE
```
    Each client bound receives messages in a round-robin fashion.
    
    See Also:
    
    Constant Field Values
  - DISCARD_NOTIFY_SENDER_ON
```
public static final int DISCARD_NOTIFY_SENDER_ON
```
    Notify sender if a message fails to be enqueued to the endpoint.
    
    See Also:
    
    EndpointProperties.setDiscardBehavior(Integer), Constant Field Values
  - DISCARD_NOTIFY_SENDER_OFF
```
public static final int DISCARD_NOTIFY_SENDER_OFF
```
    Do not notify sender if a message fails to be enqueued to the endpoint.
    
    See Also:
    
    EndpointProperties.setDiscardBehavior(Integer), Constant Field Values
- Constructor Detail
  - EndpointProperties
```
public EndpointProperties()
```
    EndpointProperties constructor using default values of null.
  - EndpointProperties
```
public EndpointProperties(Integer accessType,
                          Integer maxMsgSize,
                          Integer permission,
                          Integer quota)
```
    EndpointProperties constructor.
    
    Parameters:
    
    accessType - Access type for the endpoint.
    
    maxMsgSize - Maximum message size for the endpoint.
    
    permission - Permissions for the endpoint.
    
    quota - Quota for the endpoint. That is, the maximum size (in megabytes) available for storing messages in this spool endpoint.
  - EndpointProperties
```
public EndpointProperties(Integer accessType,
                          Integer maxMsgSize,
                          Integer permission,
                          Integer quota,
                          Boolean respectsMsgTimeToLive)
```
    EndpointProperties constructor.
    
    Parameters:
    
    accessType - Access type for the endpoint.
    
    maxMsgSize - Maximum message size for the endpoint.
    
    permission - Permissions for the endpoint.
    
    quota - Message spool quota for the endpoint.
    
    respectsMsgTimeToLive - Whether the endpoint respects Message TTL.
  - EndpointProperties
```
public EndpointProperties(Integer accessType,
                          Integer maxMsgSize,
                          Integer permission,
                          Integer quota,
                          Boolean respectsMsgTimeToLive,
                          Integer discardBehavior)
```
    EndpointProperties constructor.
    
    Parameters:
    
    accessType - Access type for the endpoint.
    
    maxMsgSize - Maximum message size for the endpoint.
    
    permission - Permissions for the endpoint.
    
    quota - Message spool quota for the endpoint.
    
    respectsMsgTimeToLive - Whether the endpoint respects Message TTL.
    
    discardBehavior - If specified, whether to notify sender if a message fails to be enqueued to the endpoint.
  - EndpointProperties
```
public EndpointProperties(Integer accessType,
                          Integer maxMsgSize,
                          Integer permission,
                          Integer quota,
                          Boolean respectsMsgTimeToLive,
                          Integer discardBehavior,
                          Integer maxMsgRedelivery)
```
    EndpointProperties constructor.
    
    Parameters:
    
    accessType - Access type for the endpoint.
    
    maxMsgSize - Maximum message size for the endpoint.
    
    permission - Permissions for the endpoint.
    
    quota - Message spool quota for the endpoint.
    
    respectsMsgTimeToLive - Whether the endpoint respects Message TTL.
    
    discardBehavior - If specified, whether to notify sender if a message fails to be enqueued to the endpoint.
    
    maxMsgRedelivery - Sets the maximum message redelivery count on the queue or topic endpoint. (Zero means retry forever).
- Method Detail
  - getAccessType
```
public Integer getAccessType()
```
    Returns the access type for the endpoint. This is not used when creating a flow.
    When used for provisioning:
    - Only applies to Durable Queues.
    - A null value means use the default value.
    Returns:
    
    The access type for the endpoint.
  - getMaxMsgSize
```
public Integer getMaxMsgSize()
```
    Returns the maximum message size for the endpoint.
    When used for provisioning:
    - A null value means use the default value.
    Returns:
    
    The maximum message size for the endpoint.
  - getPermission
```
public Integer getPermission()
```
    Returns the permission for this endpoint.
    When used for provisioning:
    - A null value means use the default value.
    Returns:
    
    The permission for this endpoint.
  - getQuota
```
public Integer getQuota()
```
    Returns the quota for the endpoint.
    When used for provisioning.
    - A null value means use the default value.
    Returns:
    
    The quota for the endpoint.
  - setAccessType
```
public void setAccessType(Integer accessType)
```
    Sets the access type for the endpoint. This applies to durable Queues only.
    When used for provisioning:
    - A null value means use the default value.
    Parameters:
    
    accessType - The access type for the endpoint.
  - setMaxMsgSize
```
public void setMaxMsgSize(Integer maxMsgSize)
```
    Sets the maximum message size for the endpoint.
    When used for provisioning:
    - A null value means use the default value.
    Parameters:
    
    maxMsgSize - The maximum message size for the endpoint.
  - setPermission
```
public void setPermission(Integer permission)
```
    Sets the permissions for the endpoint.
    When used for provisioning:
    - A null value means use the default value.
    Parameters:
    
    permission - Permissions for the endpoint.
  - setQuota
```
public void setQuota(Integer quota)
```
    Sets the message spool quota for an endpoint. This is the maximum size (in MB) available for storing messages in this spool endpoint. The valid range is greater than or equal to zero. A value of 0 configures the endpoint to act as a Last-Value-Queue, where the appliance enforces a queue depth of one, and only the most current message is spooled by the endpoint. When a new message is received, the current queued message is automatically deleted from the endpoint and the new message is spooled. There are maximum values based on your Solace Event broker configuration and version.
    When used for provisioning:
    - A null value means use the default value.
    Parameters:
    
    quota - The quota for an endpoint.
  - isRespectsMsgTTL
```
public Boolean isRespectsMsgTTL()
```
    The method returns whether the endpoint respects a message's Time-to-Live (TTL) value. If the value is false, the endpoint ignores a message's TTL value.
    - A null value means use the default value.
    Returns:
    
    Whether the endpoint respects a message's Time-to-Live value.
  - setRespectsMsgTTL
```
public void setRespectsMsgTTL(Boolean respectsMsgTimeToLive)
```
    Whether the endpoint will respect messages' Time-to-Live values. This property is used when provisioning an endpoint.
    - A null value means use the default value.
    Parameters:
    
    respectsMsgTimeToLive - Whether the endpoint recognizes messages' Time-to-Live values and removes messages that expire.
  - setDiscardBehavior
```
public void setDiscardBehavior(Integer discardBehavior)
```
    If set, whether to notify sender if a message fails to be enqueued to the endpoint.
    A null value means use the appliance default.
    
    Parameters:
    
    discardBehavior - One of EndpointProperties.DISCARD_NOTIFY_SENDER_OFF, EndpointProperties.DISCARD_NOTIFY_SENDER_ON, or null for default.
  - getDiscardBehavior
```
public Integer getDiscardBehavior()
```
    Whether to notify sender if a message fails to be enqueued to the endpoint.
    A null value means use the appliance default.
    
    See Also:
    
    EndpointProperties.setDiscardBehavior(Integer)
  - setMaxMsgRedelivery
```
public void setMaxMsgRedelivery(Integer maxMsgRedelivery)
```
    Sets the maximum message redelivery count on the queue or topic endpoint. (Zero means retry forever)
  - getMaxMsgRedelivery
```
public Integer getMaxMsgRedelivery()
```
    Defines the maximum message redelivery count on the queue or topic endpoint. (Zero means retry forever)

Class EndpointProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PERMISSION_NONE

PERMISSION_READ_ONLY

PERMISSION_CONSUME

PERMISSION_MODIFY_TOPIC

PERMISSION_DELETE

ACCESSTYPE_EXCLUSIVE

ACCESSTYPE_NONEXCLUSIVE

DISCARD_NOTIFY_SENDER_ON

DISCARD_NOTIFY_SENDER_OFF

Constructor Detail

EndpointProperties

EndpointProperties

EndpointProperties

EndpointProperties

EndpointProperties

Method Detail

getAccessType

getMaxMsgSize

getPermission

getQuota

setAccessType

setMaxMsgSize

setPermission

setQuota

isRespectsMsgTTL

setRespectsMsgTTL

setDiscardBehavior

getDiscardBehavior

setMaxMsgRedelivery

getMaxMsgRedelivery