io.pivotal.cfenv.core.CfService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-cfenv Show documentation
Java CF Env Core Library
The newest version!
/*
 * Copyright 2019 the original author or authors.
 *
 * 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
 *
 *      https://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 io.pivotal.cfenv.core;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Contains the Map of values and type-safe accessors for properties of a single service
 * defined in VCAP_SERVICES.
 *
 * @author Mark Pollack
 */
public class CfService {

	private static final String TAGS = "tags";

	private static final String CREDENTIALS = "credentials";

	private static final String VOLUME_MOUNTS = "volume_mounts";

	private final Map serviceData;

	private final CfCredentials cfCredentials;

	private final List cfVolumes;

	public CfService(Map serviceData) {
		this.serviceData = serviceData;
		this.cfCredentials = createCredentials();
		this.cfVolumes = createVolumes();
	}

	public CfCredentials createCredentials() {
		Map credentials = new HashMap<>();
		if (this.serviceData.containsKey(CREDENTIALS)) {
			credentials = (Map) this.serviceData.get(CREDENTIALS);
		}
		if (credentials == null) {
			credentials = new HashMap<>();
		}
		return new CfCredentials(credentials);
	}

	public List createVolumes() {
		List volumes = new ArrayList<>();
		if (this.serviceData.containsKey(VOLUME_MOUNTS)) {
			List> volumeDatas = (List>) this.serviceData.get(VOLUME_MOUNTS);
			for (Map volumeData : volumeDatas) {
				volumes.add(new CfVolume(volumeData));
			}
		}
		return volumes;
	}

	public Map getMap() {
		return this.serviceData;
	}

	public CfCredentials getCredentials() {
		return this.cfCredentials;
	}

	List getVolumes() {
		return cfVolumes;
	}

	public List getTags() {
		List tags = new ArrayList<>();
		if (this.serviceData.containsKey(TAGS)) {
			tags = (List) this.serviceData.get(TAGS);
		}
		return tags;
	}

	public String getLabel() {
		return this.getString("label");
	}

	public String getPlan() {
		return this.getString("plan");
	}

	public String getName() {
		String name = this.getString("name");
		if (name == null) {
			name = this.getString("binding_name");
		}
		if (name == null) {
			name = this.getString("instance_name");
		}
		return name;
	}

	public String getString(String... keys) {
		if (this.serviceData != null) {
			for (String key : keys) {
				if (this.serviceData.containsKey(key)) {
					return this.serviceData.get(key).toString();
				}
			}
		}
		return null;
	}

	// Query methods

	public boolean existsByTagIgnoreCase(String... tags) {
		if (tags != null) {
			for (String serviceTag : getTags()) {
				for (String tagToMatch : tags) {
					if (tagToMatch != null && tagToMatch.length() > 0) {
						if (tagToMatch.equalsIgnoreCase(serviceTag)) {
							return true;
						}
					}
				}
			}
		}
		return false;
	}

	public boolean existsByUriSchemeStartsWith(String... uriSchemes) {
		if (uriSchemes != null) {
			CfCredentials credentials = this.getCredentials();
			String uri = credentials.getUri();
			if (uri != null) {
				for (String uriScheme : uriSchemes) {
					if (uri.startsWith(uriScheme + "://")) {
						return true;
					}
				}
			}
		}
		return false;
	}

	/**
	 * There are common variations for the name of the uri field that prepend the schema
	 * portion of the URI, e.g. if the uri schema is 'mysql' the field name in the JSON
	 * maybe 'mysqlUri', 'mysqluri', 'mysqlUrl' or 'mysqlurl'. This method searches for
	 * the presence of these alternatively named fields in the credentials of the service
	 * @param uriSchemes list of uri prefixes to use as uriSchemes
	 * @return true if there is a uri field in the credentials map
	 */
	public boolean existsByCredentialsContainsUriField(String... uriSchemes) {
		if (uriSchemes != null) {
			CfCredentials cfCredentials = this.getCredentials();
			for (String uriScheme : uriSchemes) {
				if (cfCredentials.getMap().containsKey(uriScheme + "Uri")
						|| cfCredentials.getMap().containsKey(uriScheme + "uri")
						|| cfCredentials.getMap().containsKey(uriScheme + "Url")
						|| cfCredentials.getMap().containsKey(uriScheme + "url")) {
					return true;
				}
			}
		}
		return false;
	}

	/**
	 * @param label string to search for as a prefix in the service label
	 * @return whether the label starts with the provided string
	 */
	public boolean existsByLabelStartsWith(String label) {
		String cfLabel = this.getLabel();
		if (cfLabel != null && cfLabel.length() > 0) {
			return cfLabel.startsWith(label);
		}
		return false;
	}

	/**
	 * @param label string to search for in the service label
	 * @return whether the label includes the provided string
	 */
	public boolean existsByLabelContains(String label) {
		String cfLabel = this.getLabel();
		if (cfLabel != null && cfLabel.length() > 0) {
			return cfLabel.contains(label);
		}
		return false;
	}

	/**
	 * @param labels Strings to search for as a prefix in the service label
	 * @return whether any of the provided labels starts with the service label
	 */
	public boolean existsByLabelStartsWith(String... labels) {
		String cfLabel = this.getLabel();
		if (labels != null && cfLabel != null && !cfLabel.isEmpty()){
			for (String labelToMatch : labels){
				if (labelToMatch.startsWith(cfLabel)){
					return true;
				}
			}
		}
		return false;
	}

}