/**
* 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.net.URI;
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.PartitioningPolicy;
import com.microsoft.windowsazure.services.servicebus.implementation.TopicDescription;
/**
* Represents a topic.
*/
public class TopicInfo extends EntryModel<TopicDescription> {
/**
* Creates an instance of the <code>TopicInfo</code> class.
*/
public TopicInfo() {
super(new Entry(), new TopicDescription());
getEntry().setContent(new Content());
getEntry().getContent().setType(MediaType.APPLICATION_XML);
getEntry().getContent().setTopicDescription(getModel());
}
/**
* Creates an instance of the <code>TopicInfo</code> class using the
* specified entry.
*
* @param entry
* An <code>Entry</code> object that represents the entry for the
* topic.
*/
public TopicInfo(Entry entry) {
super(entry, entry.getContent().getTopicDescription());
}
/**
* Creates an instance of the <code>TopicInfo</code> class using the
* specified name.
*
* @param path
* A <code>String</code> object that represents the name for the
* topic.
*/
public TopicInfo(String path) {
this();
setPath(path);
}
/**
* Returns the name of the topic.
*
* @return A <code>String</code> object that represents the name of the
* topic.
*/
public String getPath() {
return getEntry().getTitle();
}
/**
* Sets the name of the topic.
*
* @param value
* A <code>String</code> that represents the name of the topic.
*
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setPath(String value) {
getEntry().setTitle(value);
return this;
}
/**
* Returns the default message time-to-live (TTL).
*
* @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).
*
* @param value
* A <code>Duration</code> object that represents the default
* message TTL.
*
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setDefaultMessageTimeToLive(Duration value) {
getModel().setDefaultMessageTimeToLive(value);
return this;
}
/**
* Returns the maximum size of the topic.
*
* @return The maximum size, in megabytes, of the topic.
*/
public Long getMaxSizeInMegabytes() {
return getModel().getMaxSizeInMegabytes();
}
/**
* Sets the maximum size of the topic.
*
* @param value
* The maximum size, in megabytes, of the topic.
*
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setMaxSizeInMegabytes(Long value) {
getModel().setMaxSizeInMegabytes(value);
return this;
}
/**
* Indicates whether duplicate message detection is required.
*
* @return <code>true</code> if duplicate message detection is required;
* otherwise, <code>false</code>.
*/
public Boolean isRequiresDuplicateDetection() {
return getModel().isRequiresDuplicateDetection();
}
/**
* Specifies whether duplicate message detection is required.
*
* @param value
* <code>true</code> if duplicate message detection is required;
* otherwise, <code>false</code>.
*
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setRequiresDuplicateDetection(Boolean value) {
getModel().setRequiresDuplicateDetection(value);
return this;
}
/**
* Returns the time span during which the service bus will detect message
* duplication.
*
* @return A <code>Duration</code> object that represents the time span for
* detecting message duplication.
*/
public Duration getDuplicateDetectionHistoryTimeWindow() {
return getModel().getDuplicateDetectionHistoryTimeWindow();
}
/**
* Sets the time span during which the service bus will detect message
* duplication.
*
* @param value
* A <code>Duration</code> object that represents the time span
* for detecting message duplication.
*
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setDuplicateDetectionHistoryTimeWindow(Duration value) {
getModel().setDuplicateDetectionHistoryTimeWindow(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>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setEnableBatchedOperations(Boolean value) {
getModel().setEnableBatchedOperations(value);
return this;
}
/**
* Returns the size of the topic.
*
* @return The size, in bytes, of the topic.
*/
public Long getSizeInBytes() {
return getModel().getSizeInBytes();
}
/**
* Sets the size in bytes.
*
* @param sizeInBytes
* A <code>Long</code> instance of the size in bytes.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setSizeInBytes(Long sizeInBytes) {
getModel().setSizeInBytes(sizeInBytes);
return this;
}
/**
* Sets the filtering message before publishing.
*
* @param filteringMessageBeforePublishing
* <code>true</code> if filter message before publishing,
* otherwise false.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setFilteringMessageBeforePublishing(
Boolean filteringMessageBeforePublishing) {
getModel().setFilteringMessagesBeforePublishing(
filteringMessageBeforePublishing);
return this;
}
/**
* Checks if is filtering message before publishing.
*
* @return <code>true</code> if filter message before publishing, otherwise
* false.
*/
public Boolean isFilteringMessageBeforePublishing() {
return getModel().isFilteringMessagesBeforePublishing();
}
/**
* Sets the anonymous accessible.
*
* @param anonymousAccessible
* <code>true</code> if is anonymous accessible, otherwise
* <code>false</code>.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setAnonymousAccessible(Boolean anonymousAccessible) {
getModel().setIsAnonymousAccessible(anonymousAccessible);
return this;
}
/**
* Checks if is anonymous accessible.
*
* @return <code>true</code> if is anonymous accessible, otherwise
* <code>false</code>.
*/
public Boolean isAnonymousAccessible() {
return getModel().isIsAnonymousAccessible();
}
/**
* Sets the status.
*
* @param status
* the status
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setStatus(EntityStatus status) {
getModel().setStatus(status);
return this;
}
/**
* Gets the status.
*
* @return An <code>EntityStatus</code> object that represents the status of
* the object.
*/
public EntityStatus getStatus() {
return getModel().getStatus();
}
/**
* Sets the created at.
*
* @param createdAt
* the created at
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setCreatedAt(Calendar createdAt) {
getModel().setCreatedAt(createdAt);
return this;
}
/**
* Gets the created at.
*
* @return A <code>Calendar</code> object which represents when the topic
* was created.
*/
public Calendar getCreatedAt() {
return getModel().getCreatedAt();
}
/**
* Sets the updated at.
*
* @param updatedAt
* A <code>Calendar</code> object which represents when the topic
* was updated.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setUpdatedAt(Calendar updatedAt) {
getModel().setUpdatedAt(updatedAt);
return this;
}
/**
* Gets the updated at.
*
* @return A <code>Calendar</code> object which represents when the topic
* was updated.
*/
public Calendar getUpdatedAt() {
return getModel().getUpdatedAt();
}
/**
* Sets the accessed at.
*
* @param accessedAt
* A <code>Calendar</code> instance representing when topic was
* last accessed at.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setAccessedAt(Calendar accessedAt) {
getModel().setAccessedAt(accessedAt);
return this;
}
/**
* Gets the accessed at.
*
* @return A <code>Calendar</code> instance representing when topic was last
* accessed at.
*/
public Calendar getAccessedAt() {
return getModel().getAccessedAt();
}
/**
* Sets the user metadata.
*
* @param userMetadata
* A <code>String</code> represents the user metadata.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setUserMetadata(String userMetadata) {
getModel().setUserMetadata(userMetadata);
return this;
}
/**
* Gets the user metadata.
*
* @return A <code>String</code> represents the user metadata.
*/
public String getUserMetadata() {
return getModel().getUserMetadata();
}
/**
* Sets the support ordering.
*
* @param supportOrdering
* <code>true</code> if supports ordering, otherwise
* <code>false</code>.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setSupportOrdering(Boolean supportOrdering) {
getModel().setSupportOrdering(supportOrdering);
return this;
}
/**
* Checks if is support ordering.
*
* @return <code>true</code> if supports ordering, otherwise
* <code>false</code>.
*/
public Boolean isSupportOrdering() {
return getModel().isSupportOrdering();
}
/**
* Sets the subscription count.
*
* @param subscriptionCount
* The count of the subscription.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setSubscriptionCount(Integer subscriptionCount) {
getModel().setSubscriptionCount(subscriptionCount);
return this;
}
/**
* Gets the subscription count.
*
* @return the count of the subscription.
*/
public Integer getSubscriptionCount() {
return getModel().getSubscriptionCount();
}
/**
* 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 auto delete on idle.
*
* @param autoDeleteOnIdle
* A <code>Duration</code> object which represents the time span
* of auto delete on idle.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setAutoDeleteOnIdle(Duration autoDeleteOnIdle) {
getModel().setAutoDeleteOnIdle(autoDeleteOnIdle);
return this;
}
/**
* Gets the auto delete on idle.
*
* @return A <code>Duration</code> object which represents the time span of
* auto delete on idle.
*/
public Duration getAutoDeleteOnIdle() {
return getModel().getAutoDeleteOnIdle();
}
/**
* Sets the partitioning policy.
*
* @param partitioningPolicy
* A <code>PartitioningPolicy</code> object which represents the
* partitioning policy.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setPartitioningPolicy(PartitioningPolicy partitioningPolicy) {
getModel().setPartitioningPolicy(partitioningPolicy);
return this;
}
/**
* Gets the partitioning policy.
*
* @return A <code>PartitioningPolicy</code> object which represents the
* partitioning policy.
*/
public PartitioningPolicy getPartitioningPolicy() {
return getModel().getPartitioningPolicy();
}
/**
* Sets the entity availability status.
*
* @param entityAvailabilityStatus
* An <code>EntityAvailabilityStatus</code> instance which
* represents the entity availability status.
* @return A <code>TopicInfo</code> object that represents the updated
* topic.
*/
public TopicInfo setEntityAvailabilityStatus(
EntityAvailabilityStatus entityAvailabilityStatus) {
getModel().setEntityAvailabilityStatus(entityAvailabilityStatus);
return this;
}
/**
* Gets the entity availability status.
*
* @return An <code>EntityAvailabilityStatus</code> instance which
* represents the entity availability status.
*/
public EntityAvailabilityStatus getEntityAvailabilityStatus() {
return getModel().getEntityAvailabilityStatus();
}
/**
* Gets the uri.
*
* @return the uri
*/
public URI getUri() {
return URI.create(getEntry().getId());
}
}