/* Copyright (c) 2008 Google Inc.
*
* 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.google.gdata.client.maps;
import com.google.gdata.client.AuthTokenFactory;
import com.google.gdata.client.Service;
import com.google.gdata.client.media.MediaService;
import com.google.gdata.data.acl.AclFeed;
import com.google.gdata.data.batch.BatchUtils;
import com.google.gdata.data.maps.FeatureFeed;
import com.google.gdata.data.maps.MapFeed;
import com.google.gdata.data.maps.VersionFeed;
import com.google.gdata.util.Version;
import com.google.gdata.util.VersionRegistry;
/**
* Extends the basic {@link MediaService} abstraction to define a service that
* is preconfigured for access to the Google Maps Data API.
*
*
*/
public class MapsService extends MediaService {
/**
* The abbreviated name of Google Maps Data API recognized by Google. The
* service name is used when requesting an authentication token.
*/
public static final String MAPS_SERVICE = "local";
/**
* The version ID of the service.
*/
public static final String MAPS_SERVICE_VERSION = "GMaps-Java/" +
MapsService.class.getPackage().getImplementationVersion();
/** GData versions supported by the Google Maps Data API. */
public static final class Versions {
/** Version 1. */
public static final Version V1 = new Version(MapsService.class, "1.0",
Service.Versions.V1);
/** Version 2. */
public static final Version V2 = new Version(MapsService.class, "2.0",
Service.Versions.V2);
/** Version {@code 2.1}. */
public static final Version V2_1 = new Version(MapsService.class, "2.1",
Service.Versions.V2_1);
private Versions() {}
}
/**
* Default GData version used by the Google Maps Data API.
*/
public static final Version DEFAULT_VERSION =
Service.initServiceVersion(MapsService.class, Versions.V2);
/**
* Constructs an instance connecting to the Google Maps Data API for an
* application with the name {@code applicationName}.
*
* @param applicationName the name of the client application accessing the
* service. Application names should preferably have the format
* [company-id]-[app-name]-[app-version]. The name will be used by the
* Google servers to monitor the source of authentication.
*/
public MapsService(String applicationName) {
super(MAPS_SERVICE, applicationName);
declareExtensions();
}
/**
* Constructs an instance connecting to the Google Maps Data API for an
* application with the name {@code applicationName} and the given {@code
* GDataRequestFactory} and {@code AuthTokenFactory}. Use this constructor to
* override the default factories.
*
* @param applicationName the name of the client application accessing the
* service. Application names should preferably have the format
* [company-id]-[app-name]-[app-version]. The name will be used by the
* Google servers to monitor the source of authentication.
* @param requestFactory the request factory that generates gdata request
* objects
* @param authTokenFactory the factory that creates auth tokens
*/
public MapsService(String applicationName,
Service.GDataRequestFactory requestFactory,
AuthTokenFactory authTokenFactory) {
super(applicationName, requestFactory, authTokenFactory);
declareExtensions();
}
/**
* Constructs an instance connecting to the Google Maps Data API with name
* {@code serviceName} for an application with the name {@code
* applicationName}. The service will authenticate at the provided {@code
* domainName}.
*
* @param applicationName the name of the client application accessing the
* service. Application names should preferably have the format
* [company-id]-[app-name]-[app-version]. The name will be used by the
* Google servers to monitor the source of authentication.
* @param protocol name of protocol to use for authentication
* ("http"/"https")
* @param domainName the name of the domain hosting the login handler
*/
public MapsService(String applicationName, String protocol,
String domainName) {
super(MAPS_SERVICE, applicationName, protocol, domainName);
declareExtensions();
}
@Override
public String getServiceVersion() {
return MAPS_SERVICE_VERSION + " " + super.getServiceVersion();
}
/**
* Returns the current GData version used by the Google Maps Data API.
*/
public static Version getVersion() {
return VersionRegistry.get().getVersion(MapsService.class);
}
/**
* Declare the extensions of the feeds for the Google Maps Data API.
*/
private void declareExtensions() {
new AclFeed().declareExtensions(extProfile);
new FeatureFeed().declareExtensions(extProfile);
new MapFeed().declareExtensions(extProfile);
new VersionFeed().declareExtensions(extProfile);
BatchUtils.declareExtensions(extProfile);
}
}