com.citrix.netscaler.nitro.resource.config.tm.tmtrafficaction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nitro Show documentation
Show all versions of nitro Show documentation
The Citrix® NetScaler® NITRO client for Java allows you to configure and monitor the NetScaler appliance programmatically in Java based applications. Source code taken from Build 121 of NetScaler release 10.1
The newest version!
/*
* Copyright (c) 2008-2015 Citrix Systems, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.citrix.netscaler.nitro.resource.config.tm;
import com.citrix.netscaler.nitro.resource.base.*;
import com.citrix.netscaler.nitro.service.nitro_service;
import com.citrix.netscaler.nitro.service.options;
import com.citrix.netscaler.nitro.util.*;
import com.citrix.netscaler.nitro.exception.nitro_exception;
class tmtrafficaction_response extends base_response
{
public tmtrafficaction[] tmtrafficaction;
}
/**
* Configuration for TM traffic action resource.
*/
public class tmtrafficaction extends base_resource
{
private String name;
private Long apptimeout;
private String sso;
private String formssoaction;
private String persistentcookie;
private String initiatelogout;
private String kcdaccount;
private String samlssoprofile;
private Long __count;
/**
*
* Name for the traffic action. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after a traffic action is created.
The following requirement applies only to the NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').
Minimum length = 1
*
*/
public void set_name(String name) throws Exception{
this.name = name;
}
/**
*
* Name for the traffic action. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after a traffic action is created.
The following requirement applies only to the NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').
Minimum length = 1
*
*/
public String get_name() throws Exception {
return this.name;
}
/**
*
* Time interval, in minutes, of user inactivity after which the connection is closed.
Minimum value = 1
Maximum value = 715827
*
*/
public void set_apptimeout(long apptimeout) throws Exception {
this.apptimeout = new Long(apptimeout);
}
/**
*
* Time interval, in minutes, of user inactivity after which the connection is closed.
Minimum value = 1
Maximum value = 715827
*
*/
public void set_apptimeout(Long apptimeout) throws Exception{
this.apptimeout = apptimeout;
}
/**
*
* Time interval, in minutes, of user inactivity after which the connection is closed.
Minimum value = 1
Maximum value = 715827
*
*/
public Long get_apptimeout() throws Exception {
return this.apptimeout;
}
/**
*
* Use single sign-on for the resource that the user is accessing now.
Possible values = ON, OFF
*
*/
public void set_sso(String sso) throws Exception{
this.sso = sso;
}
/**
*
* Use single sign-on for the resource that the user is accessing now.
Possible values = ON, OFF
*
*/
public String get_sso() throws Exception {
return this.sso;
}
/**
*
* Name of the configured form-based single sign-on profile.
*
*/
public void set_formssoaction(String formssoaction) throws Exception{
this.formssoaction = formssoaction;
}
/**
*
* Name of the configured form-based single sign-on profile.
*
*/
public String get_formssoaction() throws Exception {
return this.formssoaction;
}
/**
*
* Use persistent cookies for the traffic session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends.
Possible values = ON, OFF
*
*/
public void set_persistentcookie(String persistentcookie) throws Exception{
this.persistentcookie = persistentcookie;
}
/**
*
* Use persistent cookies for the traffic session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends.
Possible values = ON, OFF
*
*/
public String get_persistentcookie() throws Exception {
return this.persistentcookie;
}
/**
*
* Initiate logout for the traffic management (TM) session if the policy evaluates to true. The session is then terminated after two minutes.
Possible values = ON, OFF
*
*/
public void set_initiatelogout(String initiatelogout) throws Exception{
this.initiatelogout = initiatelogout;
}
/**
*
* Initiate logout for the traffic management (TM) session if the policy evaluates to true. The session is then terminated after two minutes.
Possible values = ON, OFF
*
*/
public String get_initiatelogout() throws Exception {
return this.initiatelogout;
}
/**
*
* Kerberos constrained delegation account name.
Default value: "None"
Minimum length = 1
Maximum length = 32
*
*/
public void set_kcdaccount(String kcdaccount) throws Exception{
this.kcdaccount = kcdaccount;
}
/**
*
* Kerberos constrained delegation account name.
Default value: "None"
Minimum length = 1
Maximum length = 32
*
*/
public String get_kcdaccount() throws Exception {
return this.kcdaccount;
}
/**
*
* Profile to be used for doing SAML SSO to remote relying party.
Minimum length = 1
*
*/
public void set_samlssoprofile(String samlssoprofile) throws Exception{
this.samlssoprofile = samlssoprofile;
}
/**
*
* Profile to be used for doing SAML SSO to remote relying party.
Minimum length = 1
*
*/
public String get_samlssoprofile() throws Exception {
return this.samlssoprofile;
}
/**
*
* converts nitro response into object and returns the object array in case of get request.
*
*/
protected base_resource[] get_nitro_response(nitro_service service, String response) throws Exception{
tmtrafficaction_response result = (tmtrafficaction_response) service.get_payload_formatter().string_to_resource(tmtrafficaction_response.class, response);
if(result.errorcode != 0) {
if (result.errorcode == 444) {
service.clear_session();
}
if(result.severity != null)
{
if (result.severity.equals("ERROR"))
throw new nitro_exception(result.message,result.errorcode);
}
else
{
throw new nitro_exception(result.message,result.errorcode);
}
}
return result.tmtrafficaction;
}
/**
*
* Returns the value of object identifier argument
*
*/
protected String get_object_name() {
return this.name;
}
/**
* Use this API to add tmtrafficaction.
*/
public static base_response add(nitro_service client, tmtrafficaction resource) throws Exception {
tmtrafficaction addresource = new tmtrafficaction();
addresource.name = resource.name;
addresource.apptimeout = resource.apptimeout;
addresource.sso = resource.sso;
addresource.formssoaction = resource.formssoaction;
addresource.persistentcookie = resource.persistentcookie;
addresource.initiatelogout = resource.initiatelogout;
addresource.kcdaccount = resource.kcdaccount;
addresource.samlssoprofile = resource.samlssoprofile;
return addresource.add_resource(client);
}
/**
* Use this API to add tmtrafficaction resources.
*/
public static base_responses add(nitro_service client, tmtrafficaction resources[]) throws Exception {
base_responses result = null;
if (resources != null && resources.length > 0) {
tmtrafficaction addresources[] = new tmtrafficaction[resources.length];
for (int i=0;i 0) {
tmtrafficaction deleteresources[] = new tmtrafficaction[name.length];
for (int i=0;i 0) {
tmtrafficaction deleteresources[] = new tmtrafficaction[resources.length];
for (int i=0;i 0) {
tmtrafficaction updateresources[] = new tmtrafficaction[resources.length];
for (int i=0;i 0) {
tmtrafficaction unsetresources[] = new tmtrafficaction[name.length];
for (int i=0;i 0) {
tmtrafficaction unsetresources[] = new tmtrafficaction[resources.length];
for (int i=0;i0) {
tmtrafficaction response[] = new tmtrafficaction[name.length];
tmtrafficaction obj[] = new tmtrafficaction[name.length];
for (int i=0;i