http://git-wip-us.apache.org/repos/asf/knox/blob/22a7304a/gateway-provider-security-pac4j/src/test/java/org/apache/knox/gateway/pac4j/Pac4jProviderTest.java ---------------------------------------------------------------------- diff --cc gateway-provider-security-pac4j/src/test/java/org/apache/knox/gateway/pac4j/Pac4jProviderTest.java index e4e0462,0000000..e69c599 mode 100644,000000..100644 --- a/gateway-provider-security-pac4j/src/test/java/org/apache/knox/gateway/pac4j/Pac4jProviderTest.java +++ b/gateway-provider-security-pac4j/src/test/java/org/apache/knox/gateway/pac4j/Pac4jProviderTest.java @@@ -1,150 -1,0 +1,335 @@@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.knox.gateway.pac4j; + +import org.apache.knox.gateway.audit.api.AuditContext; +import org.apache.knox.gateway.audit.api.AuditService; +import org.apache.knox.gateway.audit.api.Auditor; +import org.apache.knox.gateway.pac4j.filter.Pac4jDispatcherFilter; +import org.apache.knox.gateway.pac4j.filter.Pac4jIdentityAdapter; +import org.apache.knox.gateway.pac4j.session.KnoxSessionStore; +import org.apache.knox.gateway.services.GatewayServices; +import org.apache.knox.gateway.services.security.AliasService; +import org.apache.knox.gateway.services.security.impl.DefaultCryptoService; +import org.junit.Test; +import org.pac4j.core.client.Clients; +import org.pac4j.core.context.Pac4jConstants; +import org.pac4j.http.client.indirect.IndirectBasicAuthClient; + +import javax.servlet.*; +import javax.servlet.http.*; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; - +import static org.mockito.Mockito.*; +import static org.junit.Assert.*; + +/** + * This class simulates a full authentication process using pac4j. + */ +public class Pac4jProviderTest { + + private static final String LOCALHOST = "127.0.0.1"; + private static final String HADOOP_SERVICE_URL = "https://"; + LOCALHOST + ":8443/gateway/sandox/webhdfs/v1/tmp?op=LISTSTATUS"; + private static final String KNOXSSO_SERVICE_URL = "https://"; + LOCALHOST + ":8443/gateway/idp/api/v1/websso"; + private static final String PAC4J_CALLBACK_URL = KNOXSSO_SERVICE_URL; + private static final String ORIGINAL_URL = "originalUrl"; + private static final String CLUSTER_NAME = "knox"; + private static final String PAC4J_PASSWORD = "pwdfortest"; + private static final String CLIENT_CLASS = IndirectBasicAuthClient.class.getSimpleName(); + private static final String USERNAME = "jleleu"; + + @Test + public void test() throws Exception { + final AliasService aliasService = mock(AliasService.class); + when(aliasService.getPasswordFromAliasForCluster(CLUSTER_NAME, KnoxSessionStore.PAC4J_PASSWORD, true)).thenReturn(PAC4J_PASSWORD.toCharArray()); + when(aliasService.getPasswordFromAliasForCluster(CLUSTER_NAME, KnoxSessionStore.PAC4J_PASSWORD)).thenReturn(PAC4J_PASSWORD.toCharArray()); + + final DefaultCryptoService cryptoService = new DefaultCryptoService(); + cryptoService.setAliasService(aliasService); + + final GatewayServices services = mock(GatewayServices.class); + when(services.getService(GatewayServices.CRYPTO_SERVICE)).thenReturn(cryptoService); + when(services.getService(GatewayServices.ALIAS_SERVICE)).thenReturn(aliasService); + + final ServletContext context = mock(ServletContext.class); + when(context.getAttribute(GatewayServices.GATEWAY_SERVICES_ATTRIBUTE)).thenReturn(services); + when(context.getAttribute(GatewayServices.GATEWAY_CLUSTER_ATTRIBUTE)).thenReturn(CLUSTER_NAME); + + final FilterConfig config = mock(FilterConfig.class); + when(config.getServletContext()).thenReturn(context); + when(config.getInitParameter(Pac4jDispatcherFilter.PAC4J_CALLBACK_URL)).thenReturn(PAC4J_CALLBACK_URL); + when(config.getInitParameter("clientName")).thenReturn(Pac4jDispatcherFilter.TEST_BASIC_AUTH); + + final Pac4jDispatcherFilter dispatcher = new Pac4jDispatcherFilter(); + dispatcher.init(config); + final Pac4jIdentityAdapter adapter = new Pac4jIdentityAdapter(); + adapter.init(config); + Pac4jIdentityAdapter.setAuditor(mock(Auditor.class)); + final AuditService auditService = mock(AuditService.class); + when(auditService.getContext()).thenReturn(mock(AuditContext.class)); + Pac4jIdentityAdapter.setAuditService(auditService); + + // step 1: call the KnoxSSO service with an original url pointing to an Hadoop service (redirected by the SSOCookieProvider) + MockHttpServletRequest request = new MockHttpServletRequest(); + request.setRequestURL(KNOXSSO_SERVICE_URL + "?" + ORIGINAL_URL + "=" + HADOOP_SERVICE_URL); + request.setCookies(new Cookie[0]); + request.setServerName(LOCALHOST); + MockHttpServletResponse response = new MockHttpServletResponse(); + FilterChain filterChain = mock(FilterChain.class); + dispatcher.doFilter(request, response, filterChain); + // it should be a redirection to the idp topology + assertEquals(302, response.getStatus()); + assertEquals(PAC4J_CALLBACK_URL + "?" + Pac4jDispatcherFilter.PAC4J_CALLBACK_PARAMETER + "=true&" + Clients.DEFAULT_CLIENT_NAME_PARAMETER + "=" + CLIENT_CLASS, response.getHeaders().get("Location")); + // we should have one cookie for the saved requested url + List<Cookie> cookies = response.getCookies(); + assertEquals(1, cookies.size()); + final Cookie requestedUrlCookie = cookies.get(0); + assertEquals(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.REQUESTED_URL, requestedUrlCookie.getName()); + + // step 2: send credentials to the callback url (callback from the identity provider) + request = new MockHttpServletRequest(); + request.setCookies(new Cookie[]{requestedUrlCookie}); + request.setRequestURL(PAC4J_CALLBACK_URL + "?" + Pac4jDispatcherFilter.PAC4J_CALLBACK_PARAMETER + "=true&" + Clients.DEFAULT_CLIENT_NAME_PARAMETER + "=" + Clients.DEFAULT_CLIENT_NAME_PARAMETER + "=" + CLIENT_CLASS); + request.addParameter(Pac4jDispatcherFilter.PAC4J_CALLBACK_PARAMETER, "true"); + request.addParameter(Clients.DEFAULT_CLIENT_NAME_PARAMETER, CLIENT_CLASS); + request.addHeader("Authorization", "Basic amxlbGV1OmpsZWxldQ=="); + request.setServerName(LOCALHOST); + response = new MockHttpServletResponse(); + filterChain = mock(FilterChain.class); + dispatcher.doFilter(request, response, filterChain); + // it should be a redirection to the original url + assertEquals(302, response.getStatus()); + assertEquals(KNOXSSO_SERVICE_URL + "?" + ORIGINAL_URL + "=" + HADOOP_SERVICE_URL, response.getHeaders().get("Location")); + // we should have 3 cookies among with the user profile + cookies = response.getCookies(); + Map<String, String> mapCookies = new HashMap<>(); + assertEquals(3, cookies.size()); + for (final Cookie cookie : cookies) { + mapCookies.put(cookie.getName(), cookie.getValue()); + } + assertNull(mapCookies.get(KnoxSessionStore.PAC4J_SESSION_PREFIX + CLIENT_CLASS + "$attemptedAuthentication")); + assertNotNull(mapCookies.get(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.USER_PROFILES)); + assertNull(mapCookies.get(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.REQUESTED_URL)); + + // step 3: turn pac4j identity into KnoxSSO identity + request = new MockHttpServletRequest(); + request.setCookies(cookies.toArray(new Cookie[cookies.size()])); + request.setRequestURL(KNOXSSO_SERVICE_URL + "?" + ORIGINAL_URL + "=" + HADOOP_SERVICE_URL); + request.setServerName(LOCALHOST); + response = new MockHttpServletResponse(); + filterChain = mock(FilterChain.class); + dispatcher.doFilter(request, response, filterChain); + assertEquals(0, response.getStatus()); + adapter.doFilter(request, response, filterChain); + cookies = response.getCookies(); + assertEquals(1, cookies.size()); + final Cookie userProfileCookie = cookies.get(0); + // the user profile has been cleaned + assertEquals(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.USER_PROFILES, userProfileCookie.getName()); + assertNull(userProfileCookie.getValue()); + assertEquals(USERNAME, adapter.getTestIdentifier()); + } ++ ++ @Test ++ public void testValidIdAttribute() throws Exception { ++ final AliasService aliasService = mock(AliasService.class); ++ when(aliasService.getPasswordFromAliasForCluster(CLUSTER_NAME, KnoxSessionStore.PAC4J_PASSWORD, true)).thenReturn(PAC4J_PASSWORD.toCharArray()); ++ when(aliasService.getPasswordFromAliasForCluster(CLUSTER_NAME, KnoxSessionStore.PAC4J_PASSWORD)).thenReturn(PAC4J_PASSWORD.toCharArray()); ++ ++ final DefaultCryptoService cryptoService = new DefaultCryptoService(); ++ cryptoService.setAliasService(aliasService); ++ ++ final GatewayServices services = mock(GatewayServices.class); ++ when(services.getService(GatewayServices.CRYPTO_SERVICE)).thenReturn(cryptoService); ++ when(services.getService(GatewayServices.ALIAS_SERVICE)).thenReturn(aliasService); ++ ++ final ServletContext context = mock(ServletContext.class); ++ when(context.getAttribute(GatewayServices.GATEWAY_SERVICES_ATTRIBUTE)).thenReturn(services); ++ when(context.getAttribute(GatewayServices.GATEWAY_CLUSTER_ATTRIBUTE)).thenReturn(CLUSTER_NAME); ++ ++ final FilterConfig config = mock(FilterConfig.class); ++ when(config.getServletContext()).thenReturn(context); ++ when(config.getInitParameter(Pac4jDispatcherFilter.PAC4J_CALLBACK_URL)).thenReturn(PAC4J_CALLBACK_URL); ++ when(config.getInitParameter("clientName")).thenReturn(Pac4jDispatcherFilter.TEST_BASIC_AUTH); ++ when(config.getInitParameter(Pac4jIdentityAdapter.PAC4J_ID_ATTRIBUTE)).thenReturn("username"); ++ ++ final Pac4jDispatcherFilter dispatcher = new Pac4jDispatcherFilter(); ++ dispatcher.init(config); ++ final Pac4jIdentityAdapter adapter = new Pac4jIdentityAdapter(); ++ adapter.init(config); ++ Pac4jIdentityAdapter.setAuditor(mock(Auditor.class)); ++ final AuditService auditService = mock(AuditService.class); ++ when(auditService.getContext()).thenReturn(mock(AuditContext.class)); ++ Pac4jIdentityAdapter.setAuditService(auditService); ++ ++ // step 1: call the KnoxSSO service with an original url pointing to an Hadoop service (redirected by the SSOCookieProvider) ++ MockHttpServletRequest request = new MockHttpServletRequest(); ++ request.setRequestURL(KNOXSSO_SERVICE_URL + "?" + ORIGINAL_URL + "=" + HADOOP_SERVICE_URL); ++ request.setCookies(new Cookie[0]); ++ request.setServerName(LOCALHOST); ++ MockHttpServletResponse response = new MockHttpServletResponse(); ++ FilterChain filterChain = mock(FilterChain.class); ++ dispatcher.doFilter(request, response, filterChain); ++ // it should be a redirection to the idp topology ++ assertEquals(302, response.getStatus()); ++ assertEquals(PAC4J_CALLBACK_URL + "?" + Pac4jDispatcherFilter.PAC4J_CALLBACK_PARAMETER + "=true&" + Clients.DEFAULT_CLIENT_NAME_PARAMETER + "=" + CLIENT_CLASS, response.getHeaders().get("Location")); ++ // we should have one cookie for the saved requested url ++ List<Cookie> cookies = response.getCookies(); ++ assertEquals(1, cookies.size()); ++ final Cookie requestedUrlCookie = cookies.get(0); ++ assertEquals(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.REQUESTED_URL, requestedUrlCookie.getName()); ++ ++ // step 2: send credentials to the callback url (callback from the identity provider) ++ request = new MockHttpServletRequest(); ++ request.setCookies(new Cookie[]{requestedUrlCookie}); ++ request.setRequestURL(PAC4J_CALLBACK_URL + "?" + Pac4jDispatcherFilter.PAC4J_CALLBACK_PARAMETER + "=true&" + Clients.DEFAULT_CLIENT_NAME_PARAMETER + "=" + Clients.DEFAULT_CLIENT_NAME_PARAMETER + "=" + CLIENT_CLASS); ++ request.addParameter(Pac4jDispatcherFilter.PAC4J_CALLBACK_PARAMETER, "true"); ++ request.addParameter(Clients.DEFAULT_CLIENT_NAME_PARAMETER, CLIENT_CLASS); ++ request.addHeader("Authorization", "Basic amxlbGV1OmpsZWxldQ=="); ++ request.setServerName(LOCALHOST); ++ response = new MockHttpServletResponse(); ++ filterChain = mock(FilterChain.class); ++ dispatcher.doFilter(request, response, filterChain); ++ // it should be a redirection to the original url ++ assertEquals(302, response.getStatus()); ++ assertEquals(KNOXSSO_SERVICE_URL + "?" + ORIGINAL_URL + "=" + HADOOP_SERVICE_URL, response.getHeaders().get("Location")); ++ // we should have 3 cookies among with the user profile ++ cookies = response.getCookies(); ++ Map<String, String> mapCookies = new HashMap<>(); ++ assertEquals(3, cookies.size()); ++ for (final Cookie cookie : cookies) { ++ mapCookies.put(cookie.getName(), cookie.getValue()); ++ } ++ assertNull(mapCookies.get(KnoxSessionStore.PAC4J_SESSION_PREFIX + CLIENT_CLASS + "$attemptedAuthentication")); ++ assertNotNull(mapCookies.get(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.USER_PROFILES)); ++ assertNull(mapCookies.get(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.REQUESTED_URL)); ++ ++ // step 3: turn pac4j identity into KnoxSSO identity ++ request = new MockHttpServletRequest(); ++ request.setCookies(cookies.toArray(new Cookie[cookies.size()])); ++ request.setRequestURL(KNOXSSO_SERVICE_URL + "?" + ORIGINAL_URL + "=" + HADOOP_SERVICE_URL); ++ request.setServerName(LOCALHOST); ++ response = new MockHttpServletResponse(); ++ filterChain = mock(FilterChain.class); ++ dispatcher.doFilter(request, response, filterChain); ++ assertEquals(0, response.getStatus()); ++ adapter.doFilter(request, response, filterChain); ++ cookies = response.getCookies(); ++ assertEquals(1, cookies.size()); ++ final Cookie userProfileCookie = cookies.get(0); ++ // the user profile has been cleaned ++ assertEquals(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.USER_PROFILES, userProfileCookie.getName()); ++ assertNull(userProfileCookie.getValue()); ++ assertEquals(USERNAME, adapter.getTestIdentifier()); ++ } ++ @Test ++ public void testInvalidIdAttribute() throws Exception { ++ final AliasService aliasService = mock(AliasService.class); ++ when(aliasService.getPasswordFromAliasForCluster(CLUSTER_NAME, KnoxSessionStore.PAC4J_PASSWORD, true)).thenReturn(PAC4J_PASSWORD.toCharArray()); ++ when(aliasService.getPasswordFromAliasForCluster(CLUSTER_NAME, KnoxSessionStore.PAC4J_PASSWORD)).thenReturn(PAC4J_PASSWORD.toCharArray()); ++ ++ final DefaultCryptoService cryptoService = new DefaultCryptoService(); ++ cryptoService.setAliasService(aliasService); ++ ++ final GatewayServices services = mock(GatewayServices.class); ++ when(services.getService(GatewayServices.CRYPTO_SERVICE)).thenReturn(cryptoService); ++ when(services.getService(GatewayServices.ALIAS_SERVICE)).thenReturn(aliasService); ++ ++ final ServletContext context = mock(ServletContext.class); ++ when(context.getAttribute(GatewayServices.GATEWAY_SERVICES_ATTRIBUTE)).thenReturn(services); ++ when(context.getAttribute(GatewayServices.GATEWAY_CLUSTER_ATTRIBUTE)).thenReturn(CLUSTER_NAME); ++ ++ final FilterConfig config = mock(FilterConfig.class); ++ when(config.getServletContext()).thenReturn(context); ++ when(config.getInitParameter(Pac4jDispatcherFilter.PAC4J_CALLBACK_URL)).thenReturn(PAC4J_CALLBACK_URL); ++ when(config.getInitParameter("clientName")).thenReturn(Pac4jDispatcherFilter.TEST_BASIC_AUTH); ++ when(config.getInitParameter(Pac4jIdentityAdapter.PAC4J_ID_ATTRIBUTE)).thenReturn("larry"); ++ ++ final Pac4jDispatcherFilter dispatcher = new Pac4jDispatcherFilter(); ++ dispatcher.init(config); ++ final Pac4jIdentityAdapter adapter = new Pac4jIdentityAdapter(); ++ adapter.init(config); ++ Pac4jIdentityAdapter.setAuditor(mock(Auditor.class)); ++ final AuditService auditService = mock(AuditService.class); ++ when(auditService.getContext()).thenReturn(mock(AuditContext.class)); ++ Pac4jIdentityAdapter.setAuditService(auditService); ++ ++ // step 1: call the KnoxSSO service with an original url pointing to an Hadoop service (redirected by the SSOCookieProvider) ++ MockHttpServletRequest request = new MockHttpServletRequest(); ++ request.setRequestURL(KNOXSSO_SERVICE_URL + "?" + ORIGINAL_URL + "=" + HADOOP_SERVICE_URL); ++ request.setCookies(new Cookie[0]); ++ request.setServerName(LOCALHOST); ++ MockHttpServletResponse response = new MockHttpServletResponse(); ++ FilterChain filterChain = mock(FilterChain.class); ++ dispatcher.doFilter(request, response, filterChain); ++ // it should be a redirection to the idp topology ++ assertEquals(302, response.getStatus()); ++ assertEquals(PAC4J_CALLBACK_URL + "?" + Pac4jDispatcherFilter.PAC4J_CALLBACK_PARAMETER + "=true&" + Clients.DEFAULT_CLIENT_NAME_PARAMETER + "=" + CLIENT_CLASS, response.getHeaders().get("Location")); ++ // we should have one cookie for the saved requested url ++ List<Cookie> cookies = response.getCookies(); ++ assertEquals(1, cookies.size()); ++ final Cookie requestedUrlCookie = cookies.get(0); ++ assertEquals(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.REQUESTED_URL, requestedUrlCookie.getName()); ++ ++ // step 2: send credentials to the callback url (callback from the identity provider) ++ request = new MockHttpServletRequest(); ++ request.setCookies(new Cookie[]{requestedUrlCookie}); ++ request.setRequestURL(PAC4J_CALLBACK_URL + "?" + Pac4jDispatcherFilter.PAC4J_CALLBACK_PARAMETER + "=true&" + Clients.DEFAULT_CLIENT_NAME_PARAMETER + "=" + Clients.DEFAULT_CLIENT_NAME_PARAMETER + "=" + CLIENT_CLASS); ++ request.addParameter(Pac4jDispatcherFilter.PAC4J_CALLBACK_PARAMETER, "true"); ++ request.addParameter(Clients.DEFAULT_CLIENT_NAME_PARAMETER, CLIENT_CLASS); ++ request.addHeader("Authorization", "Basic amxlbGV1OmpsZWxldQ=="); ++ request.setServerName(LOCALHOST); ++ response = new MockHttpServletResponse(); ++ filterChain = mock(FilterChain.class); ++ dispatcher.doFilter(request, response, filterChain); ++ // it should be a redirection to the original url ++ assertEquals(302, response.getStatus()); ++ assertEquals(KNOXSSO_SERVICE_URL + "?" + ORIGINAL_URL + "=" + HADOOP_SERVICE_URL, response.getHeaders().get("Location")); ++ // we should have 3 cookies among with the user profile ++ cookies = response.getCookies(); ++ Map<String, String> mapCookies = new HashMap<>(); ++ assertEquals(3, cookies.size()); ++ for (final Cookie cookie : cookies) { ++ mapCookies.put(cookie.getName(), cookie.getValue()); ++ } ++ assertNull(mapCookies.get(KnoxSessionStore.PAC4J_SESSION_PREFIX + CLIENT_CLASS + "$attemptedAuthentication")); ++ assertNotNull(mapCookies.get(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.USER_PROFILES)); ++ assertNull(mapCookies.get(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.REQUESTED_URL)); ++ ++ // step 3: turn pac4j identity into KnoxSSO identity ++ request = new MockHttpServletRequest(); ++ request.setCookies(cookies.toArray(new Cookie[cookies.size()])); ++ request.setRequestURL(KNOXSSO_SERVICE_URL + "?" + ORIGINAL_URL + "=" + HADOOP_SERVICE_URL); ++ request.setServerName(LOCALHOST); ++ response = new MockHttpServletResponse(); ++ filterChain = mock(FilterChain.class); ++ dispatcher.doFilter(request, response, filterChain); ++ assertEquals(0, response.getStatus()); ++ adapter.doFilter(request, response, filterChain); ++ cookies = response.getCookies(); ++ assertEquals(1, cookies.size()); ++ final Cookie userProfileCookie = cookies.get(0); ++ // the user profile has been cleaned ++ assertEquals(KnoxSessionStore.PAC4J_SESSION_PREFIX + Pac4jConstants.USER_PROFILES, userProfileCookie.getName()); ++ assertNull(userProfileCookie.getValue()); ++ assertEquals(USERNAME, adapter.getTestIdentifier()); ++ } ++ +}
http://git-wip-us.apache.org/repos/asf/knox/blob/22a7304a/gateway-release/home/conf/topologies/admin.xml ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/knox/blob/22a7304a/gateway-release/home/conf/topologies/knoxsso.xml ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/knox/blob/22a7304a/gateway-release/home/conf/topologies/manager.xml ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/knox/blob/22a7304a/gateway-release/home/conf/topologies/sandbox.xml ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/knox/blob/22a7304a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java ---------------------------------------------------------------------- diff --cc gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java index 61c5303,0000000..f10f97b mode 100644,000000..100644 --- a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java +++ b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java @@@ -1,553 -1,0 +1,615 @@@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.knox.gateway; + +import org.apache.commons.cli.ParseException; +import org.apache.knox.gateway.i18n.messages.Message; +import org.apache.knox.gateway.i18n.messages.MessageLevel; +import org.apache.knox.gateway.i18n.messages.Messages; +import org.apache.knox.gateway.i18n.messages.StackTrace; +import org.apache.knox.gateway.services.security.KeystoreServiceException; + +import java.io.File; +import java.net.URI; +import java.util.Date; +import java.util.Map; +import java.util.Set; + +/** + * + */ +@Messages(logger="org.apache.knox.gateway") +public interface GatewayMessages { + + @Message( level = MessageLevel.FATAL, text = "Failed to parse command line: {0}" ) + void failedToParseCommandLine( @StackTrace( level = MessageLevel.DEBUG ) ParseException e ); + + @Message( level = MessageLevel.INFO, text = "Starting gateway..." ) + void startingGateway(); + + @Message( level = MessageLevel.FATAL, text = "Failed to start gateway: {0}" ) + void failedToStartGateway( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.INFO, text = "Started gateway on port {0}." ) + void startedGateway( int port ); + + @Message( level = MessageLevel.INFO, text = "Stopping gateway..." ) + void stoppingGateway(); + + @Message( level = MessageLevel.INFO, text = "Stopped gateway." ) + void stoppedGateway(); + + @Message( level = MessageLevel.INFO, text = "Loading configuration resource {0}" ) + void loadingConfigurationResource( String res ); + + @Message( level = MessageLevel.INFO, text = "Loading configuration file {0}" ) + void loadingConfigurationFile( String file ); + + @Message( level = MessageLevel.WARN, text = "Failed to load configuration file {0}: {1}" ) + void failedToLoadConfig( String path, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.INFO, text = "Using {1} as GATEWAY_HOME via {0}." ) + void settingGatewayHomeDir( String location, String home ); + + @Message( level = MessageLevel.INFO, text = "Loading topologies from directory: {0}" ) + void loadingTopologiesFromDirectory( String topologiesDir ); + + @Message( level = MessageLevel.DEBUG, text = "Loading topology file: {0}" ) + void loadingTopologyFile( String fileName ); + + @Message( level = MessageLevel.INFO, text = "Monitoring topologies in directory: {0}" ) + void monitoringTopologyChangesInDirectory( String topologiesDir ); + + @Message( level = MessageLevel.INFO, text = "Deploying topology {0} to {1}" ) + void deployingTopology( String clusterName, String warDirName ); + + @Message( level = MessageLevel.DEBUG, text = "Deployed topology {0}." ) + void deployedTopology( String clusterName ); + + @Message( level = MessageLevel.INFO, text = "Loading topology {0} from {1}" ) + void redeployingTopology( String clusterName, String warDirName ); + + @Message( level = MessageLevel.DEBUG, text = "Redeployed topology {0}." ) + void redeployedTopology( String clusterName ); + + @Message( level = MessageLevel.INFO, text = "Activating topology {0}" ) + void activatingTopology( String name ); + + @Message( level = MessageLevel.INFO, text = "Activating topology {0} archive {1}" ) + void activatingTopologyArchive( String topology, String archive ); + + @Message( level = MessageLevel.INFO, text = "Deactivating topology {0}" ) + void deactivatingTopology( String name ); + + @Message( level = MessageLevel.ERROR, text = "Failed to deploy topology {0}: {1}" ) + void failedToDeployTopology( String name, @StackTrace(level=MessageLevel.DEBUG) Throwable e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to redeploy topology {0}" ) + void failedToRedeployTopology( String name ); + + @Message( level = MessageLevel.ERROR, text = "Failed to redeploy topology {0}: {1}" ) + void failedToRedeployTopology( String name, @StackTrace(level=MessageLevel.DEBUG) Throwable e ); + + @Message(level = MessageLevel.ERROR, text = "Failed to load topology {0}: Topology configuration is invalid!") + void failedToLoadTopology(String fileName); + + @Message( level = MessageLevel.ERROR, text = "Failed to redeploy topologies: {0}" ) + void failedToRedeployTopologies( @StackTrace(level=MessageLevel.DEBUG) Throwable e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to undeploy topology {0}: {1}" ) + void failedToUndeployTopology( String name, @StackTrace(level=MessageLevel.DEBUG) Exception e ); + + @Message( level = MessageLevel.INFO, text = "Deleting topology {0}" ) + void deletingTopology( String topologyName ); + + @Message( level = MessageLevel.INFO, text = "Deleting deployed topology {0}" ) + void deletingDeployment( String warDirName ); + + @Message( level = MessageLevel.DEBUG, text = "Purge backups of deployed topology {0}" ) + void cleanupDeployments( String topologyName ); + + @Message( level = MessageLevel.INFO, text = "Deleting backup deployed topology {0}" ) + void cleanupDeployment( String absolutePath ); + + @Message( level = MessageLevel.INFO, text = "Creating gateway home directory: {0}" ) + void creatingGatewayHomeDir( File homeDir ); + + @Message( level = MessageLevel.INFO, text = "Creating gateway deployment directory: {0}" ) + void creatingGatewayDeploymentDir( File topologiesDir ); + + @Message( level = MessageLevel.INFO, text = "Creating default gateway configuration file: {0}" ) + void creatingDefaultConfigFile( File defaultConfigFile ); + + @Message( level = MessageLevel.INFO, text = "Creating sample topology file: {0}" ) + void creatingDefaultTopologyFile( File defaultConfigFile ); + + @Message( level = MessageLevel.WARN, text = "Ignoring service deployment contributor with invalid null name: {0}" ) + void ignoringServiceContributorWithMissingName( String className ); + + @Message( level = MessageLevel.WARN, text = "Ignoring service deployment contributor with invalid null role: {0}" ) + void ignoringServiceContributorWithMissingRole( String className ); + + @Message( level = MessageLevel.WARN, text = "Ignoring service deployment contributor with invalid null version: {0}" ) + void ignoringServiceContributorWithMissingVersion( String className ); + + @Message( level = MessageLevel.WARN, text = "Ignoring provider deployment contributor with invalid null name: {0}" ) + void ignoringProviderContributorWithMissingName( String className ); + + @Message( level = MessageLevel.WARN, text = "Ignoring provider deployment contributor with invalid null role: {0}" ) + void ignoringProviderContributorWithMissingRole( String className ); + + @Message( level = MessageLevel.INFO, text = "Loaded logging configuration: {0}" ) + void loadedLoggingConfig( String fileName ); + + @Message( level = MessageLevel.WARN, text = "Failed to load logging configuration: {0}" ) + void failedToLoadLoggingConfig( String fileName ); + + @Message( level = MessageLevel.INFO, text = "Creating credential store for the gateway instance." ) + void creatingCredentialStoreForGateway(); + + @Message( level = MessageLevel.INFO, text = "Credential store for the gateway instance found - no need to create one." ) + void credentialStoreForGatewayFoundNotCreating(); + + @Message( level = MessageLevel.INFO, text = "Creating keystore for the gateway instance." ) + void creatingKeyStoreForGateway(); + + @Message( level = MessageLevel.INFO, text = "Keystore for the gateway instance found - no need to create one." ) + void keyStoreForGatewayFoundNotCreating(); + + @Message( level = MessageLevel.INFO, text = "Creating credential store for the cluster: {0}" ) + void creatingCredentialStoreForCluster(String clusterName); + + @Message( level = MessageLevel.INFO, text = "Credential store found for the cluster: {0} - no need to create one." ) + void credentialStoreForClusterFoundNotCreating(String clusterName); + + @Message( level = MessageLevel.DEBUG, text = "Received request: {0} {1}" ) + void receivedRequest( String method, String uri ); + + @Message( level = MessageLevel.DEBUG, text = "Dispatch request: {0} {1}" ) + void dispatchRequest( String method, URI uri ); + + @Message( level = MessageLevel.WARN, text = "Connection exception dispatching request: {0} {1}" ) + void dispatchServiceConnectionException( URI uri, @StackTrace(level=MessageLevel.WARN) Exception e ); + + @Message( level = MessageLevel.DEBUG, text = "Signature verified: {0}" ) + void signatureVerified( boolean verified ); + + @Message( level = MessageLevel.DEBUG, text = "Apache Knox Gateway {0} ({1})" ) + void gatewayVersionMessage( String version, String hash ); + + @Message( level = MessageLevel.ERROR, text = "Failed to inject service {0}: {1}" ) + void failedToInjectService( String serviceName, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to finalize contribution: {0}" ) + void failedToFinalizeContribution( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to contribute service [role={1}, name={0}]: {2}" ) + void failedToContributeService( String name, String role, @StackTrace( level = MessageLevel.ERROR ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to contribute provider [role={1}, name={0}]: {2}" ) + void failedToContributeProvider( String name, String role, @StackTrace( level = MessageLevel.ERROR ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to initialize contribution: {0}" ) + void failedToInitializeContribution( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to initialize servlet instance: {0}" ) + void failedToInitializeServletInstace( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Gateway processing failed: {0}" ) + void failedToExecuteFilter( @StackTrace( level = MessageLevel.INFO ) Throwable t ); + + @Message( level = MessageLevel.ERROR, text = "Failed to load topology {0}: {1}") + void failedToLoadTopology( String fileName, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to load topology {0}, retrying after {1}ms: {2}") + void failedToLoadTopologyRetrying( String friendlyURI, String delay, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to handle topology events: {0}" ) + void failedToHandleTopologyEvents( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to reload topologies: {0}" ) + void failedToReloadTopologies( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.FATAL, text = "Unsupported encoding: {0}" ) + void unsupportedEncoding( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to persist master secret: {0}" ) + void failedToPersistMasterSecret( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to encrypt master secret: {0}" ) + void failedToEncryptMasterSecret( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to initialize master service from persistent master {0}: {1}" ) + void failedToInitializeFromPersistentMaster( String masterFileName, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to encode passphrase: {0}" ) + void failedToEncodePassphrase( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to verify signature: {0}") + void failedToVerifySignature( @StackTrace(level=MessageLevel.DEBUG) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to sign the data: {0}") + void failedToSignData( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to decrypt password for cluster {0}: {1}" ) + void failedToDecryptPasswordForCluster( String clusterName, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to encrypt password for cluster {0}: {1}") + void failedToEncryptPasswordForCluster( String clusterName, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to create keystore [filename={0}, type={1}]: {2}" ) + void failedToCreateKeystore( String fileName, String keyStoreType, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to load keystore [filename={0}, type={1}]: {2}" ) + void failedToLoadKeystore( String fileName, String keyStoreType, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to add key for cluster {0}: {1}" ) + void failedToAddKeyForCluster( String clusterName, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to add credential for cluster {0}: {1}" ) + void failedToAddCredentialForCluster( String clusterName, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to get key for Gateway {0}: {1}" ) + void failedToGetKeyForGateway( String alias, @StackTrace( level=MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to get credential for cluster {0}: {1}" ) + void failedToGetCredentialForCluster( String clusterName, @StackTrace(level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to get key for cluster {0}: {1}" ) + void failedToGetKeyForCluster( String clusterName, @StackTrace(level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to add self signed certificate for Gateway {0}: {1}" ) + void failedToAddSeflSignedCertForGateway( String alias, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to generate secret key from password: {0}" ) + void failedToGenerateKeyFromPassword( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to establish connection to {0}: {1}" ) + void failedToEstablishConnectionToUrl( String url, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to interpret property \"{0}\": {1}") + void failedToInterpretProperty( String property, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to instantiate the internal gateway services." ) + void failedToInstantiateGatewayServices(); + + @Message( level = MessageLevel.ERROR, text = "Failed to serialize map to Json string {0}: {1}" ) + void failedToSerializeMapToJSON( Map<String, Object> map, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.ERROR, text = "Failed to get map from Json string {0}: {1}" ) + void failedToGetMapFromJsonString( String json, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.DEBUG, text = "Successful Knox->Hadoop SPNegotiation authentication for URL: {0}" ) + void successfulSPNegoAuthn(String uri); + + @Message( level = MessageLevel.ERROR, text = "Failed Knox->Hadoop SPNegotiation authentication for URL: {0}" ) + void failedSPNegoAuthn(String uri); + + @Message( level = MessageLevel.DEBUG, text = "Dispatch response status: {0}" ) + void dispatchResponseStatusCode(int statusCode); + + @Message( level = MessageLevel.DEBUG, text = "Dispatch response status: {0}, Location: {1}" ) + void dispatchResponseCreatedStatusCode( int statusCode, String location ); + + @Message( level = MessageLevel.ERROR, text = "Failed to decrypt cipher text for cluster {0}: due to inability to retrieve the password." ) + void failedToDecryptCipherForClusterNullPassword(String clusterName); + + @Message( level = MessageLevel.DEBUG, text = "Gateway services have not been initialized." ) + void gatewayServicesNotInitialized(); + + @Message( level = MessageLevel.INFO, text = "The Gateway SSL certificate is issued to hostname: {0}." ) + void certificateHostNameForGateway(String cn); + + @Message( level = MessageLevel.INFO, text = "The Gateway SSL certificate is valid between: {0} and {1}." ) + void certificateValidityPeriod(Date notBefore, Date notAfter); + + @Message( level = MessageLevel.ERROR, text = "Unable to retrieve certificate for Gateway: {0}." ) + void unableToRetrieveCertificateForGateway(Exception e); + + @Message( level = MessageLevel.ERROR, text = "Failed to generate alias for cluster: {0} {1}." ) + void failedToGenerateAliasForCluster(String clusterName, KeystoreServiceException e); + + @Message( level = MessageLevel.DEBUG, text = "Key passphrase not found in credential store - using master secret." ) + void assumingKeyPassphraseIsMaster(); + + @Message( level = MessageLevel.ERROR, text = "Failed to remove alias for cluster: {0} {1}." ) + void failedToRemoveCredentialForCluster(String clusterName, Exception e); + + @Message( level = MessageLevel.WARN, text = "Failed to match path {0}" ) + void failedToMatchPath( String path ); + + @Message( level = MessageLevel.ERROR, text = "Failed to get system ldap connection: {0}" ) + void failedToGetSystemLdapConnection( @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.WARN, text = "Value not found for cluster:{0}, alias: {1}" ) + void aliasValueNotFound( String cluster, String alias ); + + @Message( level = MessageLevel.INFO, text = "Computed userDn: {0} using dnTemplate for principal: {1}" ) + void computedUserDn(String userDn, String principal); + + @Message( level = MessageLevel.DEBUG, text = "Searching from {0} where {1} scope {2}" ) + void searchBaseFilterScope( String searchBase, String searchFilter, String searchScope ); + + @Message( level = MessageLevel.INFO, text = "Computed userDn: {0} using ldapSearch for principal: {1}" ) + void searchedAndFoundUserDn(String userDn, String principal); + + @Message( level = MessageLevel.INFO, text = "Computed roles/groups: {0} for principal: {1}" ) + void lookedUpUserRoles(Set<String> roleNames, String userName); + + @Message( level = MessageLevel.DEBUG, text = "Initialize provider: {1}/{0}" ) + void initializeProvider( String name, String role ); + + @Message( level = MessageLevel.DEBUG, text = "Initialize service: {1}/{0}" ) + void initializeService( String name, String role ); + + @Message( level = MessageLevel.DEBUG, text = "Contribute provider: {1}/{0}" ) + void contributeProvider( String name, String role ); + + @Message( level = MessageLevel.DEBUG, text = "Contribute service: {1}/{0}" ) + void contributeService( String name, String role ); + + @Message( level = MessageLevel.DEBUG, text = "Finalize provider: {1}/{0}" ) + void finalizeProvider( String name, String role ); + + @Message( level = MessageLevel.DEBUG, text = "Finalize service: {1}/{0}" ) + void finalizeService( String name, String role ); + + @Message( level = MessageLevel.DEBUG, text = "Configured services directory is {0}" ) + void usingServicesDirectory(String path); + + @Message( level = MessageLevel.ERROR, text = "Failed to unmarshall service definition file {0} file : {1}" ) + void failedToLoadServiceDefinition(String fileName, @StackTrace( level = MessageLevel.DEBUG ) Exception e); + + @Message( level = MessageLevel.ERROR, text = "Failed to find service definition file {0} file : {1}" ) + void failedToFindServiceDefinitionFile(String fileName, @StackTrace( level = MessageLevel.DEBUG ) Exception e); + + @Message( level = MessageLevel.ERROR, text = "Failed to find rewrite file {0} file : {1}" ) + void failedToFindRewriteFile(String fileName, @StackTrace( level = MessageLevel.DEBUG ) Exception e); + + @Message( level = MessageLevel.ERROR, text = "Failed to unmarshall rewrite file {0} file : {1}" ) + void failedToLoadRewriteFile(String fileName, @StackTrace( level = MessageLevel.DEBUG ) Exception e); + + @Message( level = MessageLevel.DEBUG, text = "No rewrite file found in service directory {0}" ) + void noRewriteFileFound(String path); + + @Message( level = MessageLevel.DEBUG, text = "Added Service definition name: {0}, role : {1}, version : {2}" ) + void addedServiceDefinition(String serviceName, String serviceRole, String version); + + @Message( level = MessageLevel.INFO, text = "System Property: {0}={1}" ) + void logSysProp( String name, String property ); + + @Message( level = MessageLevel.ERROR, text = "Unable to get password: {0}" ) + void unableToGetPassword(@StackTrace( level = MessageLevel.DEBUG ) Exception e); + + @Message( level = MessageLevel.DEBUG, text = "Initialize application: {0}" ) + void initializeApplication( String name ); + + @Message( level = MessageLevel.DEBUG, text = "Contribute application: {0}" ) + void contributeApplication( String name ); + + @Message( level = MessageLevel.DEBUG, text = "Finalize application: {0}" ) + void finalizeApplication( String name ); + + @Message( level = MessageLevel.INFO, text = "Default topology {0} at {1}" ) + void defaultTopologySetup( String defaultTopologyName, String redirectContext ); + + @Message( level = MessageLevel.DEBUG, text = "Default topology forward from {0} to {1}" ) + void defaultTopologyForward( String oldTarget, String newTarget ); + + @Message( level = MessageLevel.ERROR, text = "Unable to setup PagedResults" ) + void unableToSetupPagedResults(); + + @Message( level = MessageLevel.INFO, text = "Ignoring PartialResultException" ) + void ignoringPartialResultException(); + + @Message( level = MessageLevel.WARN, text = "Only retrieved first {0} groups due to SizeLimitExceededException." ) + void sizeLimitExceededOnlyRetrieved(int numResults); + + @Message( level = MessageLevel.DEBUG, text = "Failed to parse path into Template: {0} : {1}" ) + void failedToParsePath( String path, @StackTrace( level = MessageLevel.DEBUG ) Exception e ); + + @Message( level = MessageLevel.DEBUG, text = "Failed to initialize metrics reporter {0} : {1}" ) + void failedToInitializeReporter( String name, @StackTrace( level = MessageLevel.DEBUG ) Exception e); + + @Message( level = MessageLevel.DEBUG, text = "Failed to start metrics reporter {0} : {1}" ) + void failedToStartReporter( String name, @StackTrace( level = MessageLevel.DEBUG ) Exception e); + + @Message( level = MessageLevel.DEBUG, text = "Failed to stop metrics reporter {0} : {1}" ) + void failedToStopReporter( String name, @StackTrace( level = MessageLevel.DEBUG ) Exception e); + + @Message( level = MessageLevel.INFO, text = "Cookie scoping feature enabled: {0}" ) + void cookieScopingFeatureEnabled( boolean enabled ); + + /** + * Log whether Topology port mapping feature is enabled/disabled. + * + * @param enabled + */ + @Message(level = MessageLevel.INFO, + text = "Topology port mapping feature enabled: {0}") + void gatewayTopologyPortMappingEnabled(final boolean enabled); + + /** + * @param topology + * @param port + */ + @Message(level = MessageLevel.DEBUG, + text = "Creating a connector for topology {0} listening on port {1}.") + void createJettyConnector(final String topology, final int port); + + /** + * @param topology + */ + @Message(level = MessageLevel.DEBUG, + text = "Creating a handler for topology {0}.") + void createJettyHandler(final String topology); + + /** + * @param oldTarget + * @param newTarget + */ + @Message(level = MessageLevel.INFO, + text = "Updating request context from {0} to {1}") + void topologyPortMappingAddContext(final String oldTarget, + final String newTarget); + + /** + * @param oldTarget + * @param newTarget + */ + @Message(level = MessageLevel.DEBUG, + text = "Updating request target from {0} to {1}") + void topologyPortMappingUpdateRequest(final String oldTarget, + final String newTarget); + + /** + * Messages for Topology Port Mapping + * + * @param port + * @param topology + */ + @Message(level = MessageLevel.ERROR, + text = "Port {0} configured for Topology - {1} is already in use.") + void portAlreadyInUse(final int port, final String topology); + + /** + * Messages for Topology Port Mapping + * + * @param port + */ + @Message(level = MessageLevel.ERROR, + text = "Port {0} is already in use.") + void portAlreadyInUse(final int port); + + /** + * Log topology and port + * + * @param topology + * @param port + */ + @Message(level = MessageLevel.INFO, + text = "Started gateway, topology \"{0}\" listening on port \"{1}\".") + void startedGateway(final String topology, final int port); + + @Message(level = MessageLevel.ERROR, + text = + " Could not find topology \"{0}\" mapped to port \"{1}\" configured in gateway-config.xml. " + + "This invalid topology mapping will be ignored by the gateway. " + + "Gateway restart will be required if in the future \"{0}\" topology is added.") + void topologyPortMappingCannotFindTopology(final String topology, final int port); + + ++ @Message( level = MessageLevel.WARN, text = "There is no registry client defined for remote configuration monitoring." ) ++ void missingClientConfigurationForRemoteMonitoring(); ++ ++ @Message( level = MessageLevel.WARN, text = "Could not resolve a remote configuration registry client for {0}." ) ++ void unresolvedClientConfigurationForRemoteMonitoring(final String clientName); ++ + @Message( level = MessageLevel.INFO, text = "Monitoring simple descriptors in directory: {0}" ) + void monitoringDescriptorChangesInDirectory(String descriptorsDir); + - + @Message( level = MessageLevel.INFO, text = "Monitoring shared provider configurations in directory: {0}" ) + void monitoringProviderConfigChangesInDirectory(String sharedProviderDir); + ++ @Message( level = MessageLevel.ERROR, text = "Error registering listener for remote configuration path {0} : {1}" ) ++ void errorAddingRemoteConfigurationListenerForPath(final String path, ++ @StackTrace( level = MessageLevel.DEBUG ) Exception e); ++ ++ @Message( level = MessageLevel.ERROR, text = "Error unregistering listener for remote configuration path {0} : {1}" ) ++ void errorRemovingRemoteConfigurationListenerForPath(final String path, ++ @StackTrace( level = MessageLevel.DEBUG ) Exception e); ++ ++ @Message( level = MessageLevel.ERROR, text = "Error downloading remote configuration {0} : {1}" ) ++ void errorDownloadingRemoteConfiguration(final String path, ++ @StackTrace( level = MessageLevel.DEBUG ) Exception e); ++ + @Message( level = MessageLevel.INFO, text = "Prevented deletion of shared provider configuration because there are referencing descriptors: {0}" ) + void preventedDeletionOfSharedProviderConfiguration(String providerConfigurationPath); + + @Message( level = MessageLevel.INFO, text = "Generated topology {0} because the associated descriptor {1} changed." ) + void generatedTopologyForDescriptorChange(String topologyName, String descriptorName); + ++ @Message( level = MessageLevel.WARN, text = "An error occurred while attempting to initialize the remote configuration monitor: {0}" ) ++ void remoteConfigurationMonitorInitFailure(final String errorMessage, ++ @StackTrace( level = MessageLevel.DEBUG ) Exception e ); ++ ++ @Message( level = MessageLevel.WARN, text = "An error occurred while attempting to start the remote configuration monitor {0} : {1}" ) ++ void remoteConfigurationMonitorStartFailure(final String monitorType, ++ final String errorMessage, ++ @StackTrace( level = MessageLevel.DEBUG ) Exception e ); ++ ++ @Message( level = MessageLevel.INFO, text = "Starting remote configuration monitor for source {0} ..." ) ++ void startingRemoteConfigurationMonitor(final String address); ++ ++ @Message( level = MessageLevel.INFO, text = "Monitoring remote configuration source {0}" ) ++ void monitoringRemoteConfigurationSource(final String address); ++ ++ @Message( level = MessageLevel.INFO, text = "Remote configuration monitor downloaded {0} configuration file {1}" ) ++ void downloadedRemoteConfigFile(final String type, final String configFileName); ++ ++ @Message( level = MessageLevel.INFO, text = "Remote configuration monitor deleted {0} configuration file {1} based on remote change." ) ++ void deletedRemoteConfigFile(final String type, final String configFileName); ++ + @Message( level = MessageLevel.ERROR, text = "An error occurred while processing {0} : {1}" ) + void simpleDescriptorHandlingError(final String simpleDesc, + @StackTrace(level = MessageLevel.DEBUG) Exception e); + + @Message(level = MessageLevel.DEBUG, text = "Successfully wrote configuration: {0}") + void wroteConfigurationFile(final String filePath); + + @Message(level = MessageLevel.ERROR, text = "Failed to write configuration: {0}") + void failedToWriteConfigurationFile(final String filePath, + @StackTrace(level = MessageLevel.DEBUG) Exception e ); + + @Message( level = MessageLevel.INFO, text = "Deleting topology {0} because the associated descriptor {1} was deleted." ) + void deletingTopologyForDescriptorDeletion(String topologyName, String descriptorName); + + @Message( level = MessageLevel.INFO, text = "Deleting descriptor {0} because the associated topology {1} was deleted." ) + void deletingDescriptorForTopologyDeletion(String descriptorName, String topologyName); + + @Message( level = MessageLevel.DEBUG, text = "Added descriptor {0} reference to provider configuration {1}." ) + void addedProviderConfigurationReference(String descriptorName, String providerConfigurationName); + + @Message( level = MessageLevel.DEBUG, text = "Removed descriptor {0} reference to provider configuration {1}." ) + void removedProviderConfigurationReference(String descriptorName, String providerConfigurationName); + ++ @Message( level = MessageLevel.WARN, ++ text = "The permissions for the remote configuration registry entry \"{0}\" are such that its content may not be trustworthy." ) ++ void suspectWritableRemoteConfigurationEntry(String entryPath); ++ ++ @Message( level = MessageLevel.WARN, ++ text = "Correcting the suspect permissions for the remote configuration registry entry \"{0}\"." ) ++ void correctingSuspectWritableRemoteConfigurationEntry(String entryPath); ++ ++ @Message(level = MessageLevel.INFO, ++ text = "A cluster configuration change was noticed for {1} @ {0}") ++ void noticedClusterConfigurationChange(final String source, final String clusterName); ++ ++ ++ @Message(level = MessageLevel.INFO, ++ text = "Triggering topology regeneration for descriptor {2} because of change to the {1} @ {0} configuration.") ++ void triggeringTopologyRegeneration(final String source, final String clusterName, final String affected); ++ ++ ++ @Message(level = MessageLevel.ERROR, ++ text = "Encountered an error while responding to {1} @ {0} configuration change: {2}") ++ void errorRespondingToConfigChange(final String source, ++ final String clusterName, ++ @StackTrace(level = MessageLevel.DEBUG) Exception e); ++ +}
