com.ibm.tivoli.maximo.weather

Class WeatherAPIService

java.lang.Object

psdi.server.AppService

com.ibm.tivoli.maximo.weather.WeatherAPIService

All Implemented Interfaces:

java.rmi.Remote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class WeatherAPIService
extends AppService

A Service class that contains general purpose methods related to Weather Service. This class is used as a service class so that general purpose utility methods relating to the any Weather interactions. to access any methods from thois service first get referecne to it using (WeatherAPIService) MXServer.getMXServer().lookup("WEATHERAPI")

Author:

Boris Dozortsev

Field Summary

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
WeatherAPIService()
WeatherAPIService(MXServer mxServer)

Method Summary

Modifier and Type	Method and Description
void	checkConnection(MboRemote weatherOrg) Process Asset Registry.
double	distance(double lat1, double lon1, double lat2, double lon2, java.lang.String uom) Calculate distance between 2 points using GPS Coordinates
java.util.Map<java.lang.String,java.lang.Object>	getCurrentWeatherForGeocode(UserInfo userInfo, double latY, double longX, java.lang.String productName) Get current weather by latitude and longitude.
java.util.Map<java.lang.String,java.lang.Object>	getCurrentWeatherForLocation(UserInfo userInfo, java.lang.String postalCode, java.lang.String locationCode, java.lang.String country, java.lang.String productName) Get current weather by postal code and country.
java.util.Map<java.lang.String,java.lang.Object>	getDailyForecastForGeocode(UserInfo userInfo, double latY, double longX, int duration, java.lang.String productName) Get daily forecast by latitude and longitude.
java.util.Map<java.lang.String,java.lang.Object>	getDailyForecastForLocation(UserInfo userInfo, java.lang.String postalCode, java.lang.String locationCode, java.lang.String country, int duration, java.lang.String productName) Get daily forecast by postal code and country.
java.util.Map<java.lang.String,java.lang.Object>	getHistoricalWeatherForGeocode(UserInfo userInfo, double latY, double longX, java.util.Date startDate, java.util.Date endDate, java.lang.String productName) Get historical weather by latitude and longitude.
java.util.Map<java.lang.String,java.lang.Object>	getHistoricalWeatherForLocation(UserInfo userInfo, java.lang.String postalCode, java.lang.String locationCode, java.lang.String country, java.util.Date startDate, java.util.Date endDate, java.lang.String productName) Get historical weather by latitude and longitude.
java.util.Map<java.lang.String,java.lang.Object>	getHourlyForecastForGeocode(UserInfo userInfo, double latY, double longX, java.lang.String hours, java.lang.String productName) Get hourly forecast by latitude and longitude.
java.util.Map<java.lang.String,java.lang.Object>	getHourlyForecastForLocation(UserInfo userInfo, java.lang.String postalCode, java.lang.String locationCode, java.lang.String country, java.lang.String hours, java.lang.String productName) Get hourly forecast by postal code and country.
java.util.List<java.lang.Object>	getProductCatalog(java.lang.String org) Get product catalog.
MboSetRemote	getServiceAddresses() Register/Unregister Weather Organization End Points.
java.util.Map<java.lang.String,java.lang.Object>	getWeatherAlertsDetails(UserInfo userInfo, java.lang.String detailKey, java.lang.String productName) Get alerts details.
java.util.Map<java.lang.String,java.lang.Object>	getWeatherAlertsForGeocode(UserInfo userInfo, double latY, double longX, java.lang.String productName) Get alerts by latitude and longitude.
java.util.Map<java.lang.String,java.lang.Object>	getWeatherAlertsForLocation(UserInfo userInfo, java.lang.String postalCode, java.lang.String locationCode, java.lang.String country, java.lang.String productName) Get weather alert by area id and country.
void	init() Init method
boolean	isWeatherLicenseInstalled(java.lang.String productName)
void	logWeatherAPICall(java.lang.String productName, java.lang.String resourceName, UserInfo userInfo) Insert data to weather asset table
void	processAssetsRegistry(MboRemote weatherZone, java.lang.String actioncode) Process Asset Registry.
void	registryEndPointsForAlerts(boolean register) Register/Unregister Weather Organization End Points.

Methods inherited from class psdi.server.AppService

checkSecurity, configure, destroy, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WeatherAPIService

public WeatherAPIService(MXServer mxServer)
                  throws java.rmi.RemoteException

Parameters:

mxServer - The "Server Environment" this Service is being created in.

Throws:

java.rmi.RemoteException

WeatherAPIService

public WeatherAPIService()
                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()

Init method

Specified by:

init in interface Service

Overrides:

init in class AppService

See Also:

Service

getCurrentWeatherForGeocode

public java.util.Map<java.lang.String,java.lang.Object> getCurrentWeatherForGeocode(UserInfo userInfo,
                                                                                    double latY,
                                                                                    double longX,
                                                                                    java.lang.String productName)
                                                                             throws java.rmi.RemoteException,
                                                                                    MXException

Get current weather by latitude and longitude.

Parameters:

userInfo - user info

latY - latitude

longX - longitude

productName - Product Name

Returns:

Weather API current weather

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getDailyForecastForGeocode

public java.util.Map<java.lang.String,java.lang.Object> getDailyForecastForGeocode(UserInfo userInfo,
                                                                                   double latY,
                                                                                   double longX,
                                                                                   int duration,
                                                                                   java.lang.String productName)
                                                                            throws java.rmi.RemoteException,
                                                                                   MXException

Get daily forecast by latitude and longitude.

Parameters:

userInfo - user info

latY - latitude

longX - longitude

duration - duration of forecast (can be 10, 5, 3)

productName - Product Name

Returns:

Weather API daily forecast

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getHourlyForecastForGeocode

public java.util.Map<java.lang.String,java.lang.Object> getHourlyForecastForGeocode(UserInfo userInfo,
                                                                                    double latY,
                                                                                    double longX,
                                                                                    java.lang.String hours,
                                                                                    java.lang.String productName)
                                                                             throws java.rmi.RemoteException,
                                                                                    MXException

Get hourly forecast by latitude and longitude.

Parameters:

userInfo - user info

latY - latitude

longX - longitude

duration - duration of forecast in hours

productName - Product Name

Returns:

Weather API hourly forecast

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getHistoricalWeatherForGeocode

public java.util.Map<java.lang.String,java.lang.Object> getHistoricalWeatherForGeocode(UserInfo userInfo,
                                                                                       double latY,
                                                                                       double longX,
                                                                                       java.util.Date startDate,
                                                                                       java.util.Date endDate,
                                                                                       java.lang.String productName)
                                                                                throws java.rmi.RemoteException,
                                                                                       MXException

Get historical weather by latitude and longitude.

Parameters:

userInfo - user info

latY - latitude

longX - longitude

startDate - start date

endDate - end date

productName - Product Name

Returns:

Weather API historical weather

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getWeatherAlertsForGeocode

public java.util.Map<java.lang.String,java.lang.Object> getWeatherAlertsForGeocode(UserInfo userInfo,
                                                                                   double latY,
                                                                                   double longX,
                                                                                   java.lang.String productName)
                                                                            throws java.rmi.RemoteException,
                                                                                   MXException

Get alerts by latitude and longitude.

Parameters:

userInfo - user info

latY - latitude

longX - longitude

productName - Product Name

Returns:

Weather API weather alert

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getWeatherAlertsDetails

public java.util.Map<java.lang.String,java.lang.Object> getWeatherAlertsDetails(UserInfo userInfo,
                                                                                java.lang.String detailKey,
                                                                                java.lang.String productName)
                                                                         throws java.rmi.RemoteException,
                                                                                MXException

Get alerts details.

Parameters:

userInfo - user info

detailKey - detail key

productName - Product Name

Returns:

Weather API alert detail

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getCurrentWeatherForLocation

public java.util.Map<java.lang.String,java.lang.Object> getCurrentWeatherForLocation(UserInfo userInfo,
                                                                                     java.lang.String postalCode,
                                                                                     java.lang.String locationCode,
                                                                                     java.lang.String country,
                                                                                     java.lang.String productName)
                                                                              throws java.rmi.RemoteException,
                                                                                     MXException

Get current weather by postal code and country.

Parameters:

userInfo - user info

postalCode - postal code

locationCode - location code

country - country

productName - Product Name

Returns:

Weather API current weather

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getDailyForecastForLocation

public java.util.Map<java.lang.String,java.lang.Object> getDailyForecastForLocation(UserInfo userInfo,
                                                                                    java.lang.String postalCode,
                                                                                    java.lang.String locationCode,
                                                                                    java.lang.String country,
                                                                                    int duration,
                                                                                    java.lang.String productName)
                                                                             throws java.rmi.RemoteException,
                                                                                    MXException

Get daily forecast by postal code and country.

Parameters:

userInfo - user info

postalCode - postal code

locationCode - location code

country - country

duration - duration of forecast (can be 10, 5, 3)

productName - Product Name

Returns:

Weather API daily forecast

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getHourlyForecastForLocation

public java.util.Map<java.lang.String,java.lang.Object> getHourlyForecastForLocation(UserInfo userInfo,
                                                                                     java.lang.String postalCode,
                                                                                     java.lang.String locationCode,
                                                                                     java.lang.String country,
                                                                                     java.lang.String hours,
                                                                                     java.lang.String productName)
                                                                              throws java.rmi.RemoteException,
                                                                                     MXException

Get hourly forecast by postal code and country.

Parameters:

userInfo - user info

postalCode - postal code

locationCode - location code

country - country

duration - duration of forecast in hours

productName - Product Name

Returns:

Weather API hourly forecast

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getHistoricalWeatherForLocation

public java.util.Map<java.lang.String,java.lang.Object> getHistoricalWeatherForLocation(UserInfo userInfo,
                                                                                        java.lang.String postalCode,
                                                                                        java.lang.String locationCode,
                                                                                        java.lang.String country,
                                                                                        java.util.Date startDate,
                                                                                        java.util.Date endDate,
                                                                                        java.lang.String productName)
                                                                                 throws java.rmi.RemoteException,
                                                                                        MXException

Get historical weather by latitude and longitude.

Parameters:

userInfo - user info

postalCode - postal code

locationCode - location code

country - country

startDate - start date

endDate - end date

productName - Product Name

Returns:

Weather API historical weather

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getWeatherAlertsForLocation

public java.util.Map<java.lang.String,java.lang.Object> getWeatherAlertsForLocation(UserInfo userInfo,
                                                                                    java.lang.String postalCode,
                                                                                    java.lang.String locationCode,
                                                                                    java.lang.String country,
                                                                                    java.lang.String productName)
                                                                             throws java.rmi.RemoteException,
                                                                                    MXException

Get weather alert by area id and country.

Parameters:

userInfo - user info

postalCode - postal code

locationCode - area id

country - country

productName - Product Name

Returns:

Weather API weather alerts

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

checkConnection

public void checkConnection(MboRemote weatherOrg)
                     throws java.rmi.RemoteException,
                            MXException

Process Asset Registry. It will register, Update or Unregister

Parameters:

org - organization

assetInfo - weather asset info

apiKey - API Key

endPointName - end point name

userInfo - user info

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getServiceAddresses

public MboSetRemote getServiceAddresses()
                                 throws java.rmi.RemoteException,
                                        MXException

Register/Unregister Weather Organization End Points.

Parameters:

userInfo - user info

Returns:

respone

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

registryEndPointsForAlerts

public void registryEndPointsForAlerts(boolean register)
                                throws java.rmi.RemoteException,
                                       MXException

Register/Unregister Weather Organization End Points.

Parameters:

userInfo - user info

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

processAssetsRegistry

public void processAssetsRegistry(MboRemote weatherZone,
                                  java.lang.String actioncode)
                           throws java.rmi.RemoteException,
                                  MXException

Process Asset Registry. It will register, Update or Unregister

Parameters:

org - organization

assetInfo - weather asset info

apiKey - API Key

endPointName - end point name

userInfo - user info

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getProductCatalog

public java.util.List<java.lang.Object> getProductCatalog(java.lang.String org)
                                                   throws java.rmi.RemoteException,
                                                          MXException

Get product catalog.

Returns:

list of all products in catalog

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

isWeatherLicenseInstalled

public boolean isWeatherLicenseInstalled(java.lang.String productName)
                                  throws MXException,
                                         java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

logWeatherAPICall

public void logWeatherAPICall(java.lang.String productName,
                              java.lang.String resourceName,
                              UserInfo userInfo)
                       throws MXException,
                              java.rmi.RemoteException

Insert data to weather asset table

Parameters:

org - organization

assetInfo - Weather Asset Info

conn - database connection to execute statement

jo - JSON Object

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException

distance

public double distance(double lat1,
                       double lon1,
                       double lat2,
                       double lon2,
                       java.lang.String uom)
                throws java.rmi.RemoteException,
                       MXException

Calculate distance between 2 points using GPS Coordinates

Parameters:

org - organization

refId - refercence Id

conn - database connection to execute statement

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException