io.sprucehill.telize.service.ITelizeGeoIPService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of telize-geoip-java-api-wrapper Show documentation

A Java API wrapper for the Telize REST API

The newest version!

/*
Copyright 2015 SpruceHill.io GmbH

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.sprucehill.telize.service;

import io.sprucehill.telize.model.GeoIPInformation;

import java.net.Inet4Address;
import java.net.Inet6Address;

/**
 * Main service interface for the Telize GeoIP service
 *
 * @author Michael Duergner
 */
public interface ITelizeGeoIPService {

    /**
     * Get GeoIP information about ones own IP address
     *
     * @return  The GeoIPInformation for the system invoking
     */
    GeoIPInformation my();

    /**
     * Get GeoIP information about the IPV4 address specified
     *
     * @param ipv4    A IPV4 address to query
     * @return        The GeoIPInformation for IPV4 address supplied
     */
    GeoIPInformation ipv4(Inet4Address ipv4);

    /**
     * Get GeoIP information about the IPV6 address specified
     *
     * @param ipv6    A IPV6 address to query
     * @return        The GeoIPInformation for the IPV6 address supplied
     */
    GeoIPInformation ipv6(Inet6Address ipv6);
}