Catalog.Persistence

URI: http://soap.zeus.com/zxtm/1.0/Catalog/Persistence/

The Catalog.Persistence interface allows management of Persistence classes. Using this interface, you can create, delete and rename persistence classes, and manage their configuration.

Methods

addPersistence( class_names ) throws ObjectAlreadyExists, InvalidObjectName, DeploymentError

Add new persistence classes.

void addPersistence(
String[] class_names
)

copyPersistence( class_names, new_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError

Copy the named persistence classes.

void copyPersistence(
String[] class_names
String[] new_names
)

deletePersistence( class_names ) throws ObjectDoesNotExist, ObjectInUse, DeploymentError

Delete the named persistence classes.

void deletePersistence(
String[] class_names
)

getCookie( class_names ) throws ObjectDoesNotExist

Get the name of the cookie used to track session persistence.

String[] getCookie(
String[] class_names
)

getCookieByLocation( location, class_names ) throws ObjectDoesNotExist

Get the name of the cookie used to track session persistence. This is a location specific function, any action will operate on the specified location.

String[] getCookieByLocation(
String location
String[] class_names
)

getDelete( class_names ) throws ObjectDoesNotExist

Get whether the session should be deleted if a failure occurs.

Boolean[] getDelete(
String[] class_names
)

getDeleteByLocation( location, class_names ) throws ObjectDoesNotExist

Get whether the session should be deleted if a failure occurs. This is a location specific function, any action will operate on the specified location.

Boolean[] getDeleteByLocation(
String location
String[] class_names
)

getFailureMode( class_names ) throws ObjectDoesNotExist

Get the action that should be taken if the session data is invalid or the node specified cannot be contacted.

Catalog.Persistence.FailureMode[] getFailureMode(
String[] class_names
)

getFailureModeByLocation( location, class_names ) throws ObjectDoesNotExist

Get the action that should be taken if the session data is invalid or the node specified cannot be contacted. This is a location specific function, any action will operate on the specified location.

Catalog.Persistence.FailureMode[] getFailureModeByLocation(
String location
String[] class_names
)

getNote( class_names ) throws ObjectDoesNotExist

Get the note for each of the named Session Persistence classes.

String[] getNote(
String[] class_names
)

getPersistenceNames()

Get the names of all the configured persistence classes.

String[] getPersistenceNames()

getSubnetPrefixLengthV4( class_names ) throws ObjectDoesNotExist

Get when using IP-based session persistence, ensure all requests from this IPv4 subnet, specified as a prefix length, are sent to the same node.

Integer[] getSubnetPrefixLengthV4(
String[] class_names
)

getSubnetPrefixLengthV4ByLocation( location, class_names ) throws ObjectDoesNotExist

Get when using IP-based session persistence, ensure all requests from this IPv4 subnet, specified as a prefix length, are sent to the same node. This is a location specific function, any action will operate on the specified location.

Integer[] getSubnetPrefixLengthV4ByLocation(
String location
String[] class_names
)

getSubnetPrefixLengthV6( class_names ) throws ObjectDoesNotExist

Get when using IP-based session persistence, ensure all requests from this IPv6 subnet, specified as a prefix length, are sent to the same node.

Integer[] getSubnetPrefixLengthV6(
String[] class_names
)

getSubnetPrefixLengthV6ByLocation( location, class_names ) throws ObjectDoesNotExist

Get when using IP-based session persistence, ensure all requests from this IPv6 subnet, specified as a prefix length, are sent to the same node. This is a location specific function, any action will operate on the specified location.

Integer[] getSubnetPrefixLengthV6ByLocation(
String location
String[] class_names
)

getTransparentAlwaysSetCookie( class_names ) throws ObjectDoesNotExist

Get when using transparent session affinity, whether or not to insert the cookie in every response

Boolean[] getTransparentAlwaysSetCookie(
String[] class_names
)

getTransparentAlwaysSetCookieByLocation( location, class_names ) throws ObjectDoesNotExist

Get when using transparent session affinity, whether or not to insert the cookie in every response This is a location specific function, any action will operate on the specified location.

Boolean[] getTransparentAlwaysSetCookieByLocation(
String location
String[] class_names
)

getTransparentDirectives( class_names ) throws ObjectDoesNotExist

Get when using transparent session affinity, the directives to include when the cookie is sent

String[] getTransparentDirectives(
String[] class_names
)

getTransparentDirectivesByLocation( location, class_names ) throws ObjectDoesNotExist

Get when using transparent session affinity, the directives to include when the cookie is sent This is a location specific function, any action will operate on the specified location.

String[] getTransparentDirectivesByLocation(
String location
String[] class_names
)

getType( class_names ) throws ObjectDoesNotExist

Gets the session method type.

Catalog.Persistence.Type[] getType(
String[] class_names
)

getTypeByLocation( location, class_names ) throws ObjectDoesNotExist

Gets the session method type. This is a location specific function, any action will operate on the specified location.

Catalog.Persistence.Type[] getTypeByLocation(
String location
String[] class_names
)

getUrl( class_names ) throws ObjectDoesNotExist

Get the URL to send to clients if the session persistence is configured to redirect users when a node dies.

String[] getUrl(
String[] class_names
)

getUrlByLocation( location, class_names ) throws ObjectDoesNotExist

Get the URL to send to clients if the session persistence is configured to redirect users when a node dies. This is a location specific function, any action will operate on the specified location.

String[] getUrlByLocation(
String location
String[] class_names
)

renamePersistence( class_names, new_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidOperation

Rename the named persistence classes.

void renamePersistence(
String[] class_names
String[] new_names
)

setCookie( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the name of the cookie used to track session persistence.

void setCookie(
String[] class_names
String[] values
)

setCookieByLocation( location, class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the name of the cookie used to track session persistence. This is a location specific function, any action will operate on the specified location.

void setCookieByLocation(
String location
String[] class_names
String[] values
)

setDelete( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set whether the session should be deleted if a failure occurs.

void setDelete(
String[] class_names
Boolean[] values
)

setDeleteByLocation( location, class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set whether the session should be deleted if a failure occurs. This is a location specific function, any action will operate on the specified location.

void setDeleteByLocation(
String location
String[] class_names
Boolean[] values
)

setFailureMode( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the action that should be taken if the session data is invalid or the node specified cannot be contacted.

void setFailureMode(
String[] class_names
Catalog.Persistence.FailureMode[] values
)

setFailureModeByLocation( location, class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the action that should be taken if the session data is invalid or the node specified cannot be contacted. This is a location specific function, any action will operate on the specified location.

void setFailureModeByLocation(
String location
String[] class_names
Catalog.Persistence.FailureMode[] values
)

setNote( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the note for each of the named Session Persistence classes.

void setNote(
String[] class_names
String[] values
)

setSubnetPrefixLengthV4( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using IP-based session persistence, ensure all requests from this IPv4 subnet, specified as a prefix length, are sent to the same node.

void setSubnetPrefixLengthV4(
String[] class_names
Integer[] values
)

setSubnetPrefixLengthV4ByLocation( location, class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using IP-based session persistence, ensure all requests from this IPv4 subnet, specified as a prefix length, are sent to the same node. This is a location specific function, any action will operate on the specified location.

void setSubnetPrefixLengthV4ByLocation(
String location
String[] class_names
Integer[] values
)

setSubnetPrefixLengthV6( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using IP-based session persistence, ensure all requests from this IPv6 subnet, specified as a prefix length, are sent to the same node.

void setSubnetPrefixLengthV6(
String[] class_names
Integer[] values
)

setSubnetPrefixLengthV6ByLocation( location, class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using IP-based session persistence, ensure all requests from this IPv6 subnet, specified as a prefix length, are sent to the same node. This is a location specific function, any action will operate on the specified location.

void setSubnetPrefixLengthV6ByLocation(
String location
String[] class_names
Integer[] values
)

setTransparentAlwaysSetCookie( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using transparent session affinity, whether or not to insert the cookie in every response

void setTransparentAlwaysSetCookie(
String[] class_names
Boolean[] values
)

setTransparentAlwaysSetCookieByLocation( location, class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using transparent session affinity, whether or not to insert the cookie in every response This is a location specific function, any action will operate on the specified location.

void setTransparentAlwaysSetCookieByLocation(
String location
String[] class_names
Boolean[] values
)

setTransparentDirectives( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using transparent session affinity, the directives to include when the cookie is sent

void setTransparentDirectives(
String[] class_names
String[] values
)

setTransparentDirectivesByLocation( location, class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set when using transparent session affinity, the directives to include when the cookie is sent This is a location specific function, any action will operate on the specified location.

void setTransparentDirectivesByLocation(
String location
String[] class_names
String[] values
)

setType( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Sets the session method type.

void setType(
String[] class_names
Catalog.Persistence.Type[] values
)

setTypeByLocation( location, class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Sets the session method type. This is a location specific function, any action will operate on the specified location.

void setTypeByLocation(
String location
String[] class_names
Catalog.Persistence.Type[] values
)

setUrl( class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the URL to send to clients if the session persistence is configured to redirect users when a node dies.

void setUrl(
String[] class_names
String[] values
)

setUrlByLocation( location, class_names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput

Set the URL to send to clients if the session persistence is configured to redirect users when a node dies. This is a location specific function, any action will operate on the specified location.

void setUrlByLocation(
String location
String[] class_names
String[] values
)

Enumerations

Catalog.Persistence.FailureMode

enum Catalog.Persistence.FailureMode {
# Choose a new node to use
newnode,
# Redirect the user to a given URL
url,
# Close the connection (using error_file on Virtual Servers > Edit > Protocol
# Settings)
close
}

Catalog.Persistence.Type

enum Catalog.Persistence.Type {
# IP-based persistence
ip,
# Universal session persistence
universal,
# Named Node session persistence
named,
# Transparent session affinity
transparent,
# Monitor application cookies
monitor-cookies,
# J2EE session persistence
j2ee,
# ASP and ASP.NET session persistence
asp,
# X-Zeus-Backend cookies
x-zeus,
# SSL Session ID persistence
ssl,
# Deprecated. Use 'monitor-cookies' instead.
kipper,
# Deprecated. Use 'transparent' instead.
sardine
}