flex.messaging.config.NetworkSettings Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 flex.messaging.config;
/**
* Network policy settings for a MessageDestination.
*/
public class NetworkSettings
{
protected String clusterId;
protected ThrottleSettings throttleSettings;
protected int subscriptionTimeoutMinutes;
// This is the more common case so make it the default
protected boolean sharedBackend = true;
private boolean sharedBackendSet = false;
private boolean reliable;
public static final String NETWORK_ELEMENT = "network";
public static final String RELIABLE_ELEMENT = "reliable";
public static final String SUBSCRIPTION_TIMEOUT_MINUTES = "subscription-timeout-minutes";
public static final String SESSION_TIMEOUT = "session-timeout"; // Deprecated - renamed to subscription-timeout-minutes; retained for legacy config support.
public static final int DEFAULT_TIMEOUT = 0; // Defaults to being invalidated when the associated FlexSession shuts down.
/**
* Constructs a default NetworkSettings instance with
* default session timeout.
*/
public NetworkSettings()
{
throttleSettings = new ThrottleSettings();
subscriptionTimeoutMinutes = DEFAULT_TIMEOUT;
}
/**
* Returns the cluster id.
*
* @return The cluster id.
*/
public String getClusterId()
{
return clusterId;
}
/**
* Sets the cluster id.
*
* @param id The cluster id.
*/
public void setClusterId(String id)
{
this.clusterId = id;
}
/**
* Returns the reliable setting.
*
* @return The reliable setting.
*/
public boolean isReliable()
{
return reliable;
}
/**
* Sets the reliable setting.
*
* @param value The value to set the reliable setting to.
*/
public void setReliable(boolean value)
{
reliable = value;
}
/**
* Returns the subscription-timeout-minutes property.
*
* @return the subscription-timeout-minutes property.
*/
public int getSubscriptionTimeoutMinutes()
{
return subscriptionTimeoutMinutes;
}
/**
* Sets the subscription-timeout-minutes property which is the idle time in
* minutes before a subscriber that no messages are being pushed to will be unsubscribed.
* A value of 0 will cause subscriptions to be kept alive as long as the associated FlexSession
* they are created over is active.
*
* @param value The value to set the subscription-timeout-minutes property to.
*/
public void setSubscriptionTimeoutMinutes(int value)
{
subscriptionTimeoutMinutes = value;
}
/**
* Returns the shared-backend property.
*
* @return the shared-backend property.
*/
public boolean isSharedBackend()
{
return sharedBackend;
}
/**
* Sets the shared-backend property.
*
* @param sharedBackend The value to set the shared-backend property to.
*/
public void setSharedBackend(boolean sharedBackend)
{
this.sharedBackend = sharedBackend;
this.sharedBackendSet = true;
}
/**
* Returns true if the shared backend has been set or false if it is
* still using the default.
*
* @return true if the shared backend has been set; false otherwise.
*/
public boolean isSharedBackendSet()
{
return sharedBackendSet;
}
/**
* Returns the ThrottleSettings property.
*
* @return the ThrottleSettings property.
*/
public ThrottleSettings getThrottleSettings()
{
return throttleSettings;
}
/**
* Sets the ThrottleSettings property.
*
* @param value The value to set the ThrottleSettings property to.
*/
public void setThrottleSettings(ThrottleSettings value)
{
throttleSettings = value;
}
}