/**
* Copyright Microsoft Corporation
*
* 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.microsoft.windowsazure.services.servicebus.models;
import java.util.Calendar;
import javax.ws.rs.core.MediaType;
import javax.xml.datatype.Duration;
import com.microsoft.windowsazure.services.servicebus.implementation.Content;
import com.microsoft.windowsazure.services.servicebus.implementation.EntityAvailabilityStatus;
import com.microsoft.windowsazure.services.servicebus.implementation.EntityStatus;
import com.microsoft.windowsazure.services.servicebus.implementation.Entry;
import com.microsoft.windowsazure.services.servicebus.implementation.EntryModel;
import com.microsoft.windowsazure.services.servicebus.implementation.MessageCountDetails;
import com.microsoft.windowsazure.services.servicebus.implementation.RuleDescription;
import com.microsoft.windowsazure.services.servicebus.implementation.SubscriptionDescription;
/**
* Represents a subscription.
*/
public class SubscriptionInfo extends EntryModel<SubscriptionDescription> {
/**
* Creates an instance of the <code>SubscriptionInfo</code> class.
*/
public SubscriptionInfo() {
super(new Entry(), new SubscriptionDescription());
getEntry().setContent(new Content());
getEntry().getContent().setType(MediaType.APPLICATION_XML);
getEntry().getContent().setSubscriptionDescription(getModel());
}
/**
* Creates an instance of the <code>SubscriptionInfo</code> class using the
* specified entry.
*
* @param entry
* An <code>Entry</code> object.
*/
public SubscriptionInfo(Entry entry) {
super(entry, entry.getContent().getSubscriptionDescription());
}
/**
* Creates an instance of the <code>SubscriptionInfo</code> class using the
* specified name.
*
* @param name
* A <code>String</code> object that represents the name of the
* subscription.
*/
public SubscriptionInfo(String name) {
this();
setName(name);
}
/**
* Returns the name of the subscription.
*
* @return A <code>String</code> object that represents the name of the
* subscription.
*/
public String getName() {
return getEntry().getTitle();
}
/**
* Sets the name of the subscription.
*
* @param value
* A <code>String</code> that represents the name of the
* subscription.
*
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setName(String value) {
getEntry().setTitle(value);
return this;
}
/**
* Returns the duration of the lock.
*
* @return A <code>Duration</code> object that represents the duration of
* the lock.
*/
public Duration getLockDuration() {
return getModel().getLockDuration();
}
/**
* Sets the duration of the lock.
*
* @param value
* The duration, in seconds, of the lock.
*
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setLockDuration(Duration value) {
getModel().setLockDuration(value);
return this;
}
/**
* Indicates whether the subscription is session-aware.
*
* @return <code>true</code> if the subscription is session aware;
* otherwise, <code>false</code>.
*/
public Boolean isRequiresSession() {
return getModel().isRequiresSession();
}
/**
* Specifies whether the subscription is session-aware.
*
* @param value
* <code>true</code> if the subscription is session aware;
* otherwise, <code>false</code>.
*
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setRequiresSession(Boolean value) {
getModel().setRequiresSession(value);
return this;
}
/**
* Returns the default message time-to-live (TTL). This applies when dead
* lettering is in effect.
*
* @return A <code>Duration</code> object that represents the default
* message TTL.
*/
public Duration getDefaultMessageTimeToLive() {
return getModel().getDefaultMessageTimeToLive();
}
/**
* Sets the default message time-to-live (TTL). This applies when dead
* lettering is in effect.
*
* @param value
* A <code>Duration</code> object that represents the default
* message TTL.
*
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setDefaultMessageTimeToLive(Duration value) {
getModel().setDefaultMessageTimeToLive(value);
return this;
}
/**
* Indicates whether dead lettering is in effect upon message expiration.
*
* @return <code>true</code> if dead lettering is in effect; otherwise,
* <code>false</code>.
*/
public Boolean isDeadLetteringOnMessageExpiration() {
return getModel().isDeadLetteringOnMessageExpiration();
}
/**
* Specifies whether dead lettering is in effect upon message expiration.
*
* @param value
* <code>true</code> if dead lettering is in effect; otherwise,
* <code>false</code>.
*
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setDeadLetteringOnMessageExpiration(Boolean value) {
getModel().setDeadLetteringOnMessageExpiration(value);
return this;
}
/**
* Indicates whether dead lettering is in effect when filter evaluation
* exceptions are encountered.
*
* @return <code>true</code> if dead lettering is in effect; otherwise,
* <code>false</code>.
*/
public Boolean isDeadLetteringOnFilterEvaluationExceptions() {
return getModel().isDeadLetteringOnFilterEvaluationExceptions();
}
/**
* Specifies whether dead lettering is in effect when filter evaluation
* exceptions are encountered.
*
* @param value
* <code>true</code> if dead lettering is in effect; otherwise,
* <code>false</code>.
*
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setDeadLetteringOnFilterEvaluationExceptions(
Boolean value) {
getModel().setDeadLetteringOnFilterEvaluationExceptions(value);
return this;
}
/**
* Returns the description of the default rule.
*
* @return A <code>RuleDescription</code> object that represents the default
* rule description.
*/
public RuleDescription getDefaultRuleDescription() {
return getModel().getDefaultRuleDescription();
}
/**
* Specifies the description for the default rule.
*
* @param value
* A <code>RuleDescription</code> object that represents the
* default rule description.
*
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setDefaultRuleDescription(RuleDescription value) {
getModel().setDefaultRuleDescription(value);
return this;
}
/**
* Returns the number of messages in the subscription.
*
* @return A <code>Long</code> object represents the count of the message.
*/
public Long getMessageCount() {
return getModel().getMessageCount();
}
/**
* Returns the maximum delivery count for the subscription.
*
* @return A <code>Integer</code> represents the maximum delivery count.
*/
public Integer getMaxDeliveryCount() {
return getModel().getMaxDeliveryCount();
}
/**
* Sets the maximum delivery count for the subscription.
*
* @param value
* A <code>value</code> represents the maximum delivery count for
* the subscription.
*
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setMaxDeliveryCount(Integer value) {
getModel().setMaxDeliveryCount(value);
return this;
}
/**
* Indicates whether batch operations are enabled.
*
* @return <code>true</code> if batch operations are enabled; otherwise,
* <code>false</code>.
*/
public Boolean isEnableBatchedOperations() {
return getModel().isEnableBatchedOperations();
}
/**
* Specifies whether batch operations are enabled.
*
* @param value
* <code>true</code> if batch operations are enabled; otherwise,
* <code>false</code>.
*
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setEnableBatchedOperations(Boolean value) {
getModel().setEnableBatchedOperations(value);
return this;
}
/**
* Sets the message count.
*
* @param messageCount
* A <code>Long</code> object represents the message count.
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setMessageCount(Long messageCount) {
getModel().setMessageCount(messageCount);
return this;
}
/**
* Sets the status.
*
* @param entityStatus
* A <code>EntityStatus</code> object represents the status of
* the entity.
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setStatus(EntityStatus entityStatus) {
getModel().setStatus(entityStatus);
return this;
}
/**
* Gets the status.
*
* @return A <code>EntityStatus</code> object represents the status of the
* entity.
*/
public EntityStatus getStatus() {
return getModel().getStatus();
}
/**
* Sets the created at.
*
* @param createdAt
* the created at
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setCreatedAt(Calendar createdAt) {
getModel().setCreatedAt(createdAt);
return this;
}
/**
* Gets the created at.
*
* @return the created at
*/
public Calendar getCreatedAt() {
return getModel().getCreatedAt();
}
/**
* Sets the updated at.
*
* @param updatedAt
* the updated at
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setUpdatedAt(Calendar updatedAt) {
getModel().setUpdatedAt(updatedAt);
return this;
}
/**
* Gets the updated at.
*
* @return the updated at
*/
public Calendar getUpdatedAt() {
return getModel().getUpdatedAt();
}
/**
* Sets the accessed at.
*
* @param accessedAt
* the accessed at
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setAccessedAt(Calendar accessedAt) {
getModel().setAccessedAt(accessedAt);
return this;
}
/**
* Gets the accessed at.
*
* @return the accessed at
*/
public Calendar getAccessedAt() {
return getModel().getAccessedAt();
}
/**
* Sets the user metadata.
*
* @param userMetadata
* the user metadata
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setUserMetadata(String userMetadata) {
getModel().setUserMetadata(userMetadata);
return this;
}
/**
* Gets the user metadata.
*
* @return the user metadata
*/
public String getUserMetadata() {
return getModel().getUserMetadata();
}
/**
* Sets the auto delete on idle.
*
* @param autoDeleteOnIdle
* A <code>Duration</code> object represents the auto delete on
* idle.
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setAutoDeleteOnIdle(Duration autoDeleteOnIdle) {
getModel().setAutoDeleteOnIdle(autoDeleteOnIdle);
return this;
}
/**
* Gets the auto delete on idle.
*
* @return A <code>Duration</code> object represents the auto delete on
* idle.
*/
public Duration getAutoDeleteOnIdle() {
return getModel().getAutoDeleteOnIdle();
}
/**
* Sets the entity availability status.
*
* @param entityAvailabilityStatus
* An <code>EntityAvailabilityStatus</code> instance representing
* the entity availiability status.
* @return A <code>SubscriptionInfo</code> object that represents the
* updated subscription.
*/
public SubscriptionInfo setEntityAvailabilityStatus(
EntityAvailabilityStatus entityAvailabilityStatus) {
getModel().setEntityAvailabilityStatus(entityAvailabilityStatus);
return this;
}
/**
* Gets the entity availability status.
*
* @return An <code>EntityAvailabilityStatus</code> instance representing
* the entity availiability status.
*/
public EntityAvailabilityStatus getEntityAvailabilityStatus() {
return getModel().getEntityAvailabilityStatus();
}
/**
* Gets the message count details.
*
* @return A <code>MessageCountDetails</code> instance representing the
* details of the message count.
*/
public MessageCountDetails getCountDetails() {
return getModel().getCountDetails();
}
/**
* Sets the forward to.
*
* @param forwardTo
* A <code>String</code> representing the string to forward to.
* @return the subscription info
*/
public SubscriptionInfo setForwardTo(String forwardTo) {
getModel().setForwardTo(forwardTo);
return this;
}
/**
* Gets a <code>String</code> representing the URI of the entity to forward
* to.
*
* @return A <code>String</code> representing the URI of the entity to
* forward to.
*/
public String getForwardTo() {
return getModel().getForwardTo();
}
}