/* * Copyright 2013, 2014, 2015 EnergyOS.org * * 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 org.energyos.espi.common.domain; public class Routes { public static final String DEFAULT = "/default"; public static final String HOME = "/home"; public static final String LOGIN = "/login"; public static final String ROOT = "/"; public static final String GBA_CERT_ID = "776198e6-59ec-5d25-950a-b34a25b93d67"; public static final String DATA_CUSTODIAN_MANAGE = "/management"; public static final String THIRD_PARTY_MANAGE = "/management"; // public static final String DATA_CUSTODIAN_API_FEED = "/api/feed"; public static final String DATA_CUSTODIAN_AUTHORIZATION = "/espi/1_1/resource/Authorization/{authorizationId}"; public static final String DATA_CUSTODIAN_HOME = "/custodian/home"; public static final String DATA_CUSTODIAN_NOTIFY_THIRD_PARTYS = "/espi/1_1/NotifyThirdParty"; public static final String DATA_CUSTODIAN_NOTIFY_THIRD_PARTY = "/espi/1_1/NotifyThirdParty/{applicationInformationId}"; // public static final String DATA_CUSTODIAN_REMOVE_ALL_OAUTH_TOKENS = // "/custodian/oauth/users/{user}/tokens/{token}"; public static final String DATA_CUSTODIAN_REST_SUBSCRIPTION_GET = "/espi/1_1/resource/Subscription/{subscriptionHashedId}"; public static final String DATA_CUSTODIAN_REST_USAGE_POINT_COLLECTION = "/espi/1_1/resource/RetailCustomer/{retailCustomerId}/UsagePoint"; public static final String DATA_CUSTODIAN_REST_USAGE_POINT_CREATE = "/espi/1_1/resource/RetailCustomer/{retailCustomerId}/UsagePoint"; public static final String DATA_CUSTODIAN_REST_USAGE_POINT_GET = "/espi/1_1/resource/RetailCustomer/{retailCustomerId}/UsagePoint/{usagePointId}"; public static final String DATA_CUSTODIAN_REST_USAGE_POINT_MEMBER = "/espi/1_1/resource/RetailCustomer/{retailCustomerHashedId}/UsagePoint/{usagePointHashedId}"; public static final String DATA_CUSTODIAN_REST_USAGE_POINT_UPDATE = "/espi/1_1/resource/RetailCustomer/{retailCustomerHashedId}/UsagePoint/{usagePointHashedId}"; public static final String DATA_CUSTODIAN_RETAIL_CUSTOMER_CREATE = "/custodian/retailcustomers/create"; public static final String DATA_CUSTODIAN_RETAIL_CUSTOMER_FORM = "/custodian/retailcustomers/form"; public static final String DATA_CUSTODIAN_RETAIL_CUSTOMER_INDEX = "/custodian/retailcustomers"; public static final String DATA_CUSTODIAN_RETAIL_CUSTOMER_SHOW = "/custodian/retailcustomers/{retailCustomerId}/show"; public static final String DATA_CUSTODIAN_RETAIL_CUSTOMER_USAGE_POINTS_CREATE = "/custodian/retailcustomers/{retailCustomerId}/usagepoints/create"; public static final String DATA_CUSTODIAN_RETAIL_CUSTOMER_USAGE_POINTS_FORM = "/custodian/retailcustomers/{retailCustomerId}/usagepoints/form"; public static final String DATA_CUSTODIAN_SCOPE_SELECTION_SCREEN = "/RetailCustomer/ScopeSelectionList"; public static final String DATA_CUSTODIAN_SUBSCRIPTION = "/espi/1_1/resource/Subscription/{subscriptionId}"; public static final String DATA_CUSTODIAN_UPLOAD = "/custodian/upload"; public static final String THIRD_PARTY_AUTHORIZATION = "/RetailCustomer/{retailCustomerId}/AuthorizationList"; public static final String THIRD_PARTY_BATCH_LIST = "/batchLists"; public static final String THIRD_PARTY_DATA_CUSTODIAN_LIST = "/RetailCustomer/{retailCustomerId}/DataCustodianList"; public static final String THIRD_PARTY_LIST = "/RetailCustomer/{retailCustomerId}/ThirdPartyList"; public static final String THIRD_PARTY_METER_READINGS_SHOW = "/meterreadings/{meterReadingId}/show"; public static final String THIRD_PARTY_NOTIFICATION = "/espi/1_1/Notification"; public static final String THIRD_PARTY_OAUTH_CODE_CALLBACK = "/espi/1_1/OAuthCallBack"; public static final String THIRD_PARTY_SCOPE_SELECTION_SCREEN = "/RetailCustomer/ScopeSelection"; public static final String THIRD_PARTY_SCOPE_SELECTION_SCREEN_WITH_RETAIL_CUSTOMER_ID = "/RetailCustomer/{retailCustomerId}/ScopeSelection"; public static final String METER_READINGS_SHOW = "/RetailCustomer/{retailCustomerId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}/show"; public static final String OAUTH_ACCESS = "/oauth/confirm_access"; public static final String OAUTH_ERROR = "/oauth/error"; public static final String OAUTH_TOKEN = "/oauth/token"; public static final String RETAIL_CUSTOMER_HOME = "/RetailCustomer/{retailCustomerId}/home"; public static final String RETAIL_CUSTOMER_DOWNLOAD_MY_DATA = "/RetailCustomer/{retailCustomerId}/DownloadMyData/UsagePoint/{usagePointId}"; public static final String RETAIL_CUSTOMER_DOWNLOAD_MY_DATA_COLLECTION = "/RetailCustomer/{retailCustomerId}/DownloadMyData/UsagePoint"; public static final String TERMS_OF_SERVICE = "/TermsOfService"; public static final String USAGE_POINT_INDEX = "/RetailCustomer/{retailCustomerId}/UsagePoint"; public static final String USAGE_POINT_INDEX_TP = "/RetailCustomer/{retailCustomerId}/UsagePoint/show"; public static final String USAGE_POINT_SHOW = "/RetailCustomer/{retailCustomerId}/UsagePoint/{usagePointId}/show"; public static final String USAGE_POINT_SHOW_TP = "/RetailCustomer/{retailCustomerId}/UsagePoint/{UsagePointHashedId}/show"; public static final String USAGE_POLICY = "/UsagePolicy"; // patterns for RESTful root access to management entities // public static final String ROOT_SERVICE_STATUS = "/espi/1_1/resource/ReadServiceStatus"; public static final String ROOT_AUTHORIZATION_COLLECTION = "/espi/1_1/resource/Authorization"; public static final String ROOT_AUTHORIZATION_MEMBER = "/espi/1_1/resource/Authorization/{authorizationId}"; public static final String ROOT_APPLICATION_INFORMATION_COLLECTION = "/espi/1_1/resource/ApplicationInformation"; public static final String ROOT_APPLICATION_INFORMATION_MEMBER = "/espi/1_1/resource/ApplicationInformation/{applicationInformationId}"; // patterns for RESTful xpath access to management entities // public static final String AUTHORIZATION_COLLECTION = "/espi/1_1/resource/RetailCustomer/{retailCustomerId}/Authorization"; public static final String AUTHORIZATION_MEMBER = "/espi/1_1/resource/RetailCustomer/{retailCustomerId}/Authorization/{authorizationId}"; public static final String SUBSCRIPTION_COLLECTION = "/espi/1_1/resource/RetailCustomer/{retailCustomerId}/Subscription"; public static final String SUBSCRIPTION_MEMBER = "/espi/1_1/resource/RetailCustomer/{retailCustomerId}/Subscription/{subscriptionHashedId}"; // patterns for RESTful root access to Resources public static final String ROOT_USAGE_POINT_COLLECTION = "/espi/1_1/resource/UsagePoint"; public static final String ROOT_USAGE_POINT_MEMBER = "/espi/1_1/resource/UsagePoint/{usagePointId}"; public static final String ROOT_METER_READING_COLLECTION = "/espi/1_1/resource/MeterReading"; public static final String ROOT_METER_READING_MEMBER = "/espi/1_1/resource/MeterReading/{meterReadingId}"; public static final String ROOT_READING_TYPE_COLLECTION = "/espi/1_1/resource/ReadingType"; public static final String ROOT_READING_TYPE_MEMBER = "/espi/1_1/resource/ReadingType/{readingTypeId}"; public static final String ROOT_INTERVAL_BLOCK_COLLECTION = "/espi/1_1/resource/IntervalBlock"; public static final String ROOT_INTERVAL_BLOCK_MEMBER = "/espi/1_1/resource/IntervalBlock/{intervalBlockId}"; public static final String ROOT_TIME_CONFIGURATION_COLLECTION = "/espi/1_1/resource/LocalTimeParameters"; public static final String ROOT_TIME_CONFIGURATION_MEMBER = "/espi/1_1/resource/LocalTimeParameters/{timeConfigurationId}"; public static final String ROOT_ELECTRIC_POWER_QUALITY_SUMMARY_COLLECTION = "/espi/1_1/resource/ElectricPowerQualitySummary"; public static final String ROOT_ELECTRIC_POWER_QUALITY_SUMMARY_MEMBER = "/espi/1_1/resource/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}"; public static final String ROOT_ELECTRIC_POWER_USAGE_SUMMARY_COLLECTION = "/espi/1_1/resource/ElectricPowerUsageSummary"; public static final String ROOT_ELECTRIC_POWER_USAGE_SUMMARY_MEMBER = "/espi/1_1/resource/ElectricPowerUsageSummary/{electricPowerUsageSummaryId}"; // patterns for RESTful xpath based access to Resources public static final String USAGE_POINT_COLLECTION = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint"; public static final String USAGE_POINT_MEMBER = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}"; public static final String METER_READING_COLLECTION = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading"; public static final String METER_READING_MEMBER = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}"; public static final String INTERVAL_BLOCK_COLLECTION = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}/IntervalBlock"; public static final String INTERVAL_BLOCK_MEMBER = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}/IntervalBlock/{intervalBlockId}"; public static final String ELECTRIC_POWER_QUALITY_SUMMARY_COLLECTION = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary"; public static final String ELECTRIC_POWER_QUALITY_SUMMARY_MEMBER = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}"; public static final String ELECTRIC_POWER_USAGE_SUMMARY_COLLECTION = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary"; public static final String ELECTRIC_POWER_USAGE_SUMMARY_MEMBER = "/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary/{electricPowerUsageSummaryId}"; // patterns for RESTful RetailCustomer services public static final String RETAIL_CUSTOMER_COLLECTION = "/espi/1_1/resource/RetailCustomer"; public static final String RETAIL_CUSTOMER_MEMBER = "/espi/1_1/resource/RetailCustomer/{retailCustomerId}"; // patterns for RESTful Batch services public static final String BATCH_DOWNLOAD_MY_DATA_COLLECTION = "/espi/1_1/resource/Batch/RetailCustomer/{retailCustomerId}/UsagePoint"; public static final String BATCH_DOWNLOAD_MY_DATA_MEMBER = "/espi/1_1/resource/Batch/RetailCustomer/{retailCustomerId}/UsagePoint/{usagePointId}"; public static final String BATCH_UPLOAD_MY_DATA = "/espi/1_1/resource/Batch/RetailCustomer/{retailCustomerId}/UsagePoint"; public static final String BATCH_BULK_MEMBER = "/espi/1_1/resource/Batch/Bulk/{bulkId}"; public static final String BATCH_SUBSCRIPTION = "/espi/1_1/resource/Batch/Subscription/{subscriptionId}"; public static final String BATCH_SUBSCRIPTION_USAGEPOINT = "/espi/1_1/resource/Batch/Subscription/{subscriptionId}/UsagePoint"; public static final String BATCH_SUBSCRIPTION_USAGEPOINT_MEMBER = "/espi/1_1/resource/Batch/Subscription/{subscriptionId}/UsagePoint/{usagePointId}"; public static String buildDataCustodianRESTUsagePointGet( String retailCustomerId, String usagePointId) { return DATA_CUSTODIAN_REST_USAGE_POINT_GET.replace( "{retailCustomerId}", retailCustomerId).replace( "{usagePointId}", usagePointId); } public static String getDataCustodianRESTSubscriptionGetURL( String subscriptionHashedId) { return DATA_CUSTODIAN_REST_SUBSCRIPTION_GET.replace( "{subscriptionHashedId}", subscriptionHashedId); } }