com.twilio.sdk.resource.instance.sip.IpAccessControlList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio-java-sdk Show documentation
Release Candidate for Next-Gen Twilio Java Helper Library
There is a newer version: 7.0.0-rc-10
package com.twilio.sdk.resource.instance.sip;

import com.twilio.sdk.TwilioRestClient;
import com.twilio.sdk.TwilioRestException;
import com.twilio.sdk.TwilioRestResponse;
import com.twilio.sdk.resource.InstanceResource;
import com.twilio.sdk.resource.factory.sip.IpAddressFactory;
import com.twilio.sdk.resource.list.sip.IpAddressList;

import java.util.Date;
import java.util.Map;

public class IpAccessControlList extends InstanceResource {

	/** The Constant SID_PROPERTY. */
	private static final String SID_PROPERTY = "sid";

	/**
	 * Instantiates a new IpAccessControlList.
	 *
	 * @param client the client
	 */
	public IpAccessControlList(TwilioRestClient client) {
		super(client);
	}

	/**
	 * Instantiates a new IpAccessControlList.
	 *
	 * @param client the client
	 * @param sid the sid
	 */
	public IpAccessControlList(TwilioRestClient client, String sid) {
		super(client);
		if (sid == null) {
			throw new IllegalStateException("The Sid for a IpAccessControlList can not be null");
		}
		this.setProperty(SID_PROPERTY, sid);
	}

	/**
	 * Instantiates a new IpAccessControlList.
	 *
	 * @param client the client
	 * @param properties the properties
	 */
	public IpAccessControlList(TwilioRestClient client, Map properties) {
		super(client, properties);
	}

	/* (non-Javadoc)
	 * @see com.twilio.sdk.resource.Resource#getResourceLocation()
	 */
	@Override
		protected String getResourceLocation() {
			return "/" + TwilioRestClient.DEFAULT_VERSION + "/Accounts/"
				+ this.getRequestAccountSid() + "/SIP/IpAccessControlLists/" + this.getSid()
				+ ".json";
		}

	/*
	 * Property getters
	 */

	/**
	 * Gets the sid.
	 *
	 * @return the sid
	 */
	public String getSid() {
		return this.getProperty(SID_PROPERTY);
	}

	/**
	 * Gets the date created.
	 *
	 * @return the date created
	 */
	public Date getDateCreated() {
		return getDateProperty("date_created");
	}

	/**
	 * Gets the date updated.
	 *
	 * @return the date updated
	 */
	public Date getDateUpdated() {
		return getDateProperty("date_updated");
	}

	/**
	 * Gets the account sid.
	 *
	 * @return the account sid
	 */
	public String getAccountSid() {
		return this.getProperty("account_sid");
	}

	/**
	 * Gets the friendly name
	 *
	 * @return the friendly name
	 */
	public String getFriendlyName() {
		return this.getProperty("friendly_name");
	}

	/**
	 * Gets the ip addresses on this list.
	 *
	 * @return an AddressList of the addresses on this list
	 */
	public IpAddressList getIpAddresses() {
		IpAddressList ipAddressList = new IpAddressList(this.getClient(), this.getSid());
		ipAddressList.setRequestAccountSid(this.getRequestAccountSid());
		return ipAddressList;
	}

	/**
	 * Gets the IpAddressFactory, which lets you make new IpAddresses.
	 *
	 * @return an IpAddressList of the IpAddresses on this list
	 */
	public IpAddressFactory getIpAddressFactory() {
		return this.getIpAddresses();
	}

	/**
	 * Gets the ip IpAddresses on this list.
	 *
	 * @return an IpAddressList of the IpAddresses on this list
	 */
	public IpAddress getIpAddress(String ipAddressSid) {
		IpAddress ipAddress = new IpAddress(this.getClient(), this.getSid(), ipAddressSid);
		ipAddress.setRequestAccountSid(this.getRequestAccountSid());
		return ipAddress;
	}

	/**
	 * Delete this {@link IpAccessControlList}.
	 * @throws TwilioRestException
	 *             if there is an error in the request
	 * @return true, if successful
	 *
	 */
	public boolean delete() throws TwilioRestException {
		TwilioRestResponse response = this.getClient().safeRequest(
				this.getResourceLocation(), "DELETE", (Map) null);

		return !response.isError();
	}
}