com.vmware.photon.controller.model.util.ServiceEndpointLocator Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017 VMware, Inc. 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.
 */

package com.vmware.photon.controller.model.util;

import java.net.URI;
import java.net.URISyntaxException;

/**
 * The interface abstracts the manner to locate a service end-point. Currently the interface
 * contains only service entry point that is represented as URI, however in future it might include
 * auth mechanism, etc.
 */
public interface ServiceEndpointLocator {

    /**
     * The entry point of the service (as a string). Might be {@code null}.
     */
    String getUri();

    /**
     * The entry point of the service (as a URI). Might be {@code null} if {@link #getUri()} returns
     * null or empty.
     *
     * @throws URISyntaxException
     */
    default URI getServiceUri() throws URISyntaxException {
        final String uri = getUri();
        return uri == null || uri.isEmpty() ? null : new URI(uri);
    }

}