Snitch.java example

Explorer
cereebro-master
/*
 * Copyright © 2017 the original authors (http://cereebro.io)
 *
 * 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 io.cereebro.core;

import java.net.URI;

/**
 * Tells everything about a few known components and their relationships.
 * 
 * @author michaeltecourt
 */
public interface Snitch {

    /**
     * Snitch URI.
     * 
     * @return Snitch URI.
     */
    URI getUri();

    /**
     * Describe a visible fragment of the system.
     * 
     * @return a SystemFragment.
     * @throws SnitchingException
     *             when something goes wrong while snitching.
     */
    SystemFragment snitch();

}