Track external interfaces between the webservice and query microservices

[jwomeara]

Existing External Interfaces

Covered?	Existing Class	Base Path URI	Keep or Drop	New Class	Service	Notes
Yes	AuditBean	/Common/Auditor	Keep	AuditController	Audit Service	Add remote auth profile and add a route in HAProxy.
Yes	QueryExecutorBean	/Query	Keep	QueryController	Query Service	Most endpoints will be preserved - some won't.
Yes	CachedResultsBean	/CachedResults	Keep	CachedResultsQueryController	Query Service	Functionality lives in starter - rest API is in query service.
Yes	TableAdminBean	/Accumulo	Keep	AdminController	Accumulo Service	Add remote auth profile and add a route in HAProxy.
Yes	StatsBean	/Accumulo	Keep	StatsController	Accumulo Service	Add remote auth profile and add a route in HAProxy.
Yes	LookupBean	/Accumulo	Keep	LookupController	Accumulo Service	Add remote auth profile and add a route in HAProxy.
Yes	PermissionsBean	/Accumulo	Keep	AdminController	Accumulo Service	Add remote auth profile and add a route in HAProxy.
Yes	UpdateBean	/Accumulo	Keep	AdminController	Accumulo Service	Add remote auth profile and add a route in HAProxy.
Yes	ListTablesBean	/Accumulo	Keep	AdminController	Accumulo Service	Add remote auth profile and add a route in HAProxy.
Yes	ListUserAuthorizationsBean	/Accumulo	Keep	AdminController	Accumulo Service	Add remote auth profile and add a route in HAProxy.
Yes	ListUserPermissionsBean	/Accumulo	Keep	AdminController	Accumulo Service	Add remote auth profile and add a route in HAProxy.
Yes	ListUsersBean	/Accumulo	Keep	AdminController	Accumulo Service	Add remote auth profile and add a route in HAProxy.
Yes	DataDictionaryBean	/DataDictionary	Keep	DataDictionaryOperations	Dictionary Service	Add remote auth profile and add a route in HAProxy.
Yes	EdgeDictionaryBean	/EdgeDictionary	Keep	EdgeDictionaryOperations	Dictionary Service	Add remote auth profile and add a route in HAProxy.
No	AtomServiceBean	/Atom	Shelve			Can we drop this?
Yes	ConfigurationBean	/Common/Configuration	Keep	*	*	All of the spring-boot microservices have refresh endpoints now, so we should be covered.
Yes	AccumuloTableCacheBean	/Common/AccumuloTableCache	Keep	QueryExecutorController	Executor Service	The executor service may need the ability to reload it's accumulo table cache.
Yes	AccumuloConnectionFactoryBean	/Common/AccumuloConnectionFactory	Keep	QueryExecutorController	Executor Service	Add remote auth profile and add a route in HAProxy.
Yes	HealthBean	/Common/Health	Keep	*	*	This will now be handled as part of the actuator health (i.e. mgmt/health) and shutdown (i.e. mgmt/shutdown) endpoints. Shutdown prevents new requests while allowing existing requests to finish.
Yes	ModelBean	/Model	Keep	ModelController	DictionaryService	Verify that all needed functionality is covered.
Yes	ModificationBean	/Modification	Keep	ModificationController	Modification Service	INB - Is this used anywhere? Do we need this? It allows us to list and modify modification services.
Yes	ModificationCacheBean	/Modification	Keep	ModificationController	Modification Service	INB - Is this used anywhere? Do we need this? It allows us to list mutable fields and reload the mutable field cache.
No	QueryCacheBean	/Query/Cache	?	?	?	All queries are cached now. What endpoints do we want to support for accessing our query cache and where should that live?
Yes	DashboardBean	/Query/Metrics/dashboard	Drop			As far as I know, this is not used. Seems droppable to me.
Yes	HudBean	/Query/queryhud	Drop			As far as I know, this is not used. Seems droppable to me.
Yes	QueryMetricsBean	/Query/Metrics	Keep	QueryMetricOperations	Query Metric Service	Just need to add a route in HAProxy for this.
No	BasicQueryBean	/BasicQuery	Shelve			Query wizard stuff. Do we need this? Does anyone use this?
Yes	IdTranslatorBean	/Query	Keep	QueryController	Query Service
Yes	MapReduceBean	/MapReduce	?	MapReduceQueryController	QueryService	JWO - Might still be needed? Query Microservices might work as a substitute.
Yes	MapReduceStatusUpdateBean	/MapReduceStatus	?	MapReduceQueryController	QueryService	Looks like this is a callback handler for BulkResults jobs which updates the internal state of the job. This was implemented, but is this still needed?
Yes	CredentialsCacheBean	/Security/Admin/Credentials	Keep	AuthorizationOperations	Authorization Service	Add remote auth profile and add a route in HAProxy. The listAccumuloAuths and reloadAccumuloAuths endpoints will probably be left behind.
Yes	UserOperationsBase	/Security/User	Keep	AuthorizationOperations	AuthorizationService	Add remote auth profile and add a route in HAProxy.
Yes	web-services/deploy/docs/docs/index.html	index.html	Keep	resources/templates/index.html	QueryService	Hosted as a static resource in the query service.
Yes	web-services/deploy/docs/docs/query_help.html	query_help.html	Keep	resources/remplates/query_help.html	QueryService	Hosted as a static resource in the query service.
Yes	Enunciate Docs	/doc	Shelve			Replaced by swagger API docs