path: root/src/main/java/org/onap/dmaap/dbcapi/model/DR_Sub.java

/*-
 * ============LICENSE_START=======================================================
 * org.onap.dmaap
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.dmaap.dbcapi.model;

import java.nio.charset.StandardCharsets;

import javax.xml.bind.annotation.XmlRootElement;

import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;
import org.onap.dmaap.dbcapi.logging.DmaapbcLogMessageEnum;

@XmlRootElement
public class DR_Sub extends DmaapObject {

	private String dcaeLocationName;
	private String username;
	private String userpwd;
	private String feedId;
	private String deliveryURL;
	private String logURL;
	private String subId;
	private boolean use100;
	private boolean suspended;
	private String owner;
	private boolean guaranteedDelivery;
	private boolean guaranteedSequence;
	private boolean privilegedSubscriber;
	private boolean decompress;

	// NOTE: the following fields are optional in the API but not stored in the DB

	private	String	feedName;
	private String	feedVersion;
	public DR_Sub() {

	}

	public DR_Sub( String dLN,
					String uN,
					String uP,
					String fI,
					String dU,
					String lU,
					boolean u100 ) {
		this.dcaeLocationName = dLN;
		this.username = uN;
		this.userpwd = uP;
		this.feedId = fI;
		this.deliveryURL = dU;
		this.logURL = lU;
		this.use100 = u100;
		this.setStatus( DmaapObject_Status.NEW );
		this.subId = "0";
	}

	public DR_Sub ( String json ) {
		logger.info( "DR_Sub:" + json );
		JSONParser parser = new JSONParser();
		JSONObject jsonObj;

		try {
			jsonObj = (JSONObject) parser.parse( json );
		} catch ( ParseException pe ) {
			errorLogger.error( DmaapbcLogMessageEnum.JSON_PARSING_ERROR, "DR_Sub", json );
            this.setStatus( DmaapObject_Status.INVALID );
            return;
        }

		this.setOwner( (String) jsonObj.get("subscriber"));
		this.setSuspended( (boolean) jsonObj.get("suspend"));

		try {
			JSONObject links = (JSONObject) jsonObj.get("links");
			String url = (String) links.get("feed");
			this.setFeedId( url.substring( url.lastIndexOf('/')+1, url.length() ));
			url = (String) links.get("self");
			this.setSubId( url.substring( url.lastIndexOf('/')+1, url.length() ));
			logger.info( "feedid="+ this.getFeedId() );
			this.setLogURL( (String) links.get("log") );
		} catch (NullPointerException npe ) {

		}
		try {
			this.setGuaranteedDelivery( (boolean) jsonObj.get("guaranteed_delivery"));
		} catch( NullPointerException npe ) {
			this.setGuaranteedDelivery(false);
		}
		try {
			this.setGuaranteedSequence( (boolean) jsonObj.get("guaranteed_sequence"));
		} catch( NullPointerException npe ) {
			this.setGuaranteedSequence(false);
		}
		try {
			this.setPrivilegedSubscriber((boolean) jsonObj.get("privilegedSubscriber"));
		} catch( NullPointerException npe ) {
			this.setPrivilegedSubscriber(false);
		}
		try {
			this.setDecompress((boolean) jsonObj.get("decompress"));
		} catch( NullPointerException npe ) {
			this.setDecompress(false);
		}

		JSONObject del = (JSONObject) jsonObj.get("delivery");
		this.setDeliveryURL( (String) del.get("url") );
		this.setUsername( (String) del.get("user"));
		this.setUserpwd( (String) del.get( "password"));
		this.setUse100((boolean) del.get( "use100"));

		this.setStatus( DmaapObject_Status.VALID );

		logger.info( "new DR_Sub returning");
	}

	public String getOwner() {
		return owner;
	}

	public void setOwner(String owner) {
		this.owner = owner;
	}

	public boolean isSuspended() {
		return suspended;
	}

	public void setSuspended(boolean suspended) {
		this.suspended = suspended;
	}



	public boolean isUse100() {
		return use100;
	}

	public void setUse100(boolean use100) {
		this.use100 = use100;
	}

	public String getDcaeLocationName() {
		return dcaeLocationName;
	}

	public void setDcaeLocationName(String dcaeLocationName) {
		this.dcaeLocationName = dcaeLocationName;
	}

	public String getUsername() {
		return username;
	}

	public void setUsername(String username) {
		this.username = username;
	}

	public String getUserpwd() {
		return userpwd;
	}

	public void setUserpwd(String userpwd) {
		this.userpwd = userpwd;
	}

	public String getFeedId() {
		return feedId;
	}

	public void setFeedId(String feedId) {
		this.feedId = feedId;
	}

	public String getDeliveryURL() {
		return deliveryURL;
	}

	public void setDeliveryURL(String deliveryURL) {
		this.deliveryURL = deliveryURL;
	}

	public String getLogURL() {
		return logURL;
	}

	public void setLogURL(String logURL) {
		this.logURL = logURL;
	}

	public String getSubId() {
		return subId;
	}

	public void setSubId(String subId) {
		this.subId = subId;
	}


	public boolean isGuaranteedDelivery() {
		return guaranteedDelivery;
	}

	public void setGuaranteedDelivery(boolean guaranteedDelivery) {
		this.guaranteedDelivery = guaranteedDelivery;
	}

	public boolean isGuaranteedSequence() {
		return guaranteedSequence;
	}

	public void setGuaranteedSequence(boolean guaranteedSequence) {
		this.guaranteedSequence = guaranteedSequence;
	}

	public boolean isPrivilegedSubscriber() {
		return privilegedSubscriber;
	}

	public void setPrivilegedSubscriber(boolean privilegedSubscriber) {
		this.privilegedSubscriber = privilegedSubscriber;
	}

	public boolean isDecompress() {
		return decompress;
	}

	public void setDecompress(boolean decompressData) {
		this.decompress = decompressData;
	}

	public String getFeedName() {
		return feedName;
	}

	public void setFeedName(String feedName) {
		this.feedName = feedName;
	}

	public String getFeedVersion() {
		return feedVersion;
	}

	public void setFeedVersion(String feedVersion) {
		this.feedVersion = feedVersion;
	}

	public byte[] getBytes(String provApi) {
		if ( "AT&T".equals(provApi)) {
			return toProvJSONforATT().getBytes(StandardCharsets.UTF_8);
		}
		return toProvJSON().getBytes(StandardCharsets.UTF_8);
	}
	// returns the DR_Sub object in JSON that conforms to ONAP DR Prov Server expectations
	public String toProvJSON() {
		// this is the original DR API that was contributed to ONAP
		String postJSON = String.format("{\"suspend\": %s, \"delivery\":"
				+ "{\"url\": \"%s\", \"user\": \"%s\", \"password\": \"%s\", \"use100\":  %s }"
				+ ", \"metadataOnly\": %s, \"groupid\": \"%s\", \"follow_redirect\": %s "
				+ ", \"privilegedSubscriber\": %s, \"decompress\": %s "
				+ "}"
				,this.suspended
				,this.getDeliveryURL()
				,this.getUsername()
				,this.getUserpwd()
				,this.isUse100()
				,"false"
				,"0"
				,"true"
				,this.isPrivilegedSubscriber()
				,this.isDecompress()
			);

		logger.info( postJSON );
		return postJSON;
	}
	// returns the DR_Sub object in JSON that conforms to AT&T DR Prov Server expectations
	// In Jan, 2019, the DR API used internally at AT&T diverged, so this function can be used in
	// that runtime environment
	public String toProvJSONforATT() {
		// in DR 3.0, API v2.1 a new groupid field is added.  We are not using this required field so just set it to 0.
		// we send this regardless of DR Release because older versions of DR seem to safely ignore it
		// and soon those versions won't be around anyway...
		// Similarly, in the 1704 Release, a new subscriber attribute "follow_redirect" was introduced.
		// We are setting it to "true" because that is the general behavior desired in OpenDCAE.
		// But it is really a no-op for OpenDCAE because we've deployed DR with the SYSTEM-level parameter for FOLLOW_REDIRECTS set to true.
		// In the event we abandon that, then setting the sub attribute to true will be a good thing.
		// Update Jan, 2019: added guaranteed_delivery and guaranteed_sequence with value false for
		// backwards compatibility
		// TODO:
		//   - introduce Bus Controller API support for these attributes
		//   - store the default values in the DB
		String postJSON = String.format("{\"suspend\": %s, \"delivery\":"
				+ "{\"url\": \"%s\", \"user\": \"%s\", \"password\": \"%s\", \"use100\":  %s}"
				+ ", \"metadataOnly\": %s, \"groupid\": \"%s\", \"follow_redirect\": %s "
				+ ", \"guaranteed_delivery\": %s, \"guaranteed_sequence\": %s"
				+ "}"
				,this.suspended
				,this.getDeliveryURL()
				,this.getUsername()
				,this.getUserpwd()
				,this.isUse100()
				,"false"
				,"0"
				,"true"
				,this.isGuaranteedDelivery()
				,this.isGuaranteedSequence()
				);

		logger.info( postJSON );
		return postJSON;
	}

	@Override
	public String toString() {
		return String.format ( "DR_Sub: {dcaeLocationName=%s username=%s userpwd=%s feedId=%s deliveryURL=%s logURL=%s subid=%s use100=%s suspended=%s owner=%s}",
				dcaeLocationName,
				username,
				userpwd,
				feedId,
				deliveryURL,
				logURL,
				subId,
				use100,
				suspended,
				owner
				);
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		if (o == null || getClass() != o.getClass()) {
			return false;
		}

		DR_Sub drSub = (DR_Sub) o;

		if (use100 != drSub.use100) {
			return false;
		}
		if (suspended != drSub.suspended) {
			return false;
		}
		if (!dcaeLocationName.equals(drSub.dcaeLocationName)) {
			return false;
		}
		if (!username.equals(drSub.username)) {
			return false;
		}
		if (!userpwd.equals(drSub.userpwd)) {
			return false;
		}
		if (!feedId.equals(drSub.feedId)) {
			return false;
		}
		return subId.equals(drSub.subId);
	}

	@Override
	public int hashCode() {
		int result = dcaeLocationName.hashCode();
		result = 31 * result + username.hashCode();
		result = 31 * result + userpwd.hashCode();
		result = 31 * result + feedId.hashCode();
		result = 31 * result + subId.hashCode();
		result = 31 * result + (use100 ? 1 : 0);
		result = 31 * result + (suspended ? 1 : 0);
		return result;
	}
}