org.geoserver.config.ServiceInfo Maven / Gradle / Ivy
The newest version!
/* Copyright (c) 2001 - 2008 TOPP - www.openplans.org. All rights reserved.
* This code is licensed under the GPL 2.0 license, available at the root
* application directory.
*/
package org.geoserver.config;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.geoserver.catalog.MetadataLinkInfo;
import org.geotools.util.Version;
/**
* Generic / abstract service configuration.
*
* @author Justin Deoliveira, The Open Planning Project
*/
public interface ServiceInfo {
/**
* Identifer.
*/
String getId();
/**
* Name of the service.
*
* This value is unique among all instances of ServiceInfo and can be used
* as an identifier.
*
*
* @uml.property name="name"
*/
String getName();
/**
* Sets the name of the service.
*
* @uml.property name="name"
*/
void setName(String name);
/**
* The global geoserver configuration.
*
* @uml.property name="geoServer"
* @uml.associationEnd inverse="service:org.geoserver.config.GeoServerInfo"
*/
GeoServerInfo getGeoServer();
/**
* Sets the global geoserver configuration.
*
* @uml.property name="geoServer"
*/
void setGeoServer(GeoServerInfo geoServer);
/**
* @uml.property name="citeCompliant"
*/
boolean isCiteCompliant();
/**
* @uml.property name="citeCompliant"
*/
void setCiteCompliant(boolean citeCompliant);
/**
* @uml.property name="enabled"
*/
boolean isEnabled();
/**
* @uml.property name="enabled"
*/
void setEnabled(boolean enabled);
/**
* @uml.property name="onlineResource"
*/
String getOnlineResource();
/**
* @uml.property name="onlineResource"
*/
void setOnlineResource(String onlineResource);
/**
* @uml.property name="title"
*/
String getTitle();
/**
* @uml.property name="title"
*/
void setTitle(String title);
/**
* @uml.property name="abstract"
*/
String getAbstract();
/**
* @uml.property name="abstract"
*/
void setAbstract(String abstrct);
/**
* @uml.property name="maintainer"
*/
String getMaintainer();
/**
* @uml.property name="maintainer"
*/
void setMaintainer(String maintainer);
/**
* @uml.property name="fees"
*/
String getFees();
/**
* @uml.property name="fees"
*/
void setFees(String fees);
/**
* @uml.property name="accessConstraints"
*/
String getAccessConstraints();
/**
* @uml.property name="accessConstraints"
*/
void setAccessConstraints(String accessConstraints);
/**
* The versions of the service that are available.
*
* This list contains objects of type {@link Version}.
*
*
* @uml.property name="versions"
*/
List getVersions();
/**
* Keywords associated with the service.
*
* @uml.property name="keywords"
*/
List getKeywords();
/**
* Exception formats the service can provide.
*
* @uml.property name="exceptionFormats"
*/
List getExceptionFormats();
/**
* The service metadata link.
*
* @uml.property name="metadataLink"
* @uml.associationEnd inverse="service:org.geoserver.catalog.MetadataLinkInfo"
*/
MetadataLinkInfo getMetadataLink();
/**
* Setter of the property metadataLink
*
* @uml.property name="metadataLink"
*/
void setMetadataLink(MetadataLinkInfo metadataLink);
/**
* Sets the output strategy used by the service.
*
* This value is an identifier which indicates how the output of a response
* should behave. An example might be "performance", indicating that the
* response should be encoded as quickly as possible.
*
*
*/
String getOutputStrategy();
/**
* Sets the output strategy.
*/
void setOutputStrategy( String outputStrategy );
/**
* The base url for the schemas describing the service.
*/
String getSchemaBaseURL();
/**
* Sets the base url for the schemas describing the service.
*/
void setSchemaBaseURL( String schemaBaseURL );
/**
* Flag indicating if the service should be verbose or not.
*/
boolean isVerbose();
/**
* Sets the flag indicating if the service should be verbose or not.
*/
void setVerbose( boolean verbose );
/**
* @uml.property name="metadata"
*/
Map getMetadata();
Map getClientProperties();
}