Build a Service Interceptor in Eclipse

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

import com.esri.arcgis.enterprise.interceptor.Interceptor;
import com.esri.arcgis.enterprise.interceptor.server.IServerServicesInterceptor;
import com.esri.arcgis.enterprise.interceptor.IInterceptorRequest;
import com.esri.arcgis.enterprise.interceptor.IInterceptorResponse;
import com.esri.arcgis.enterprise.interceptor.server.IServerServicesInterceptorChain;
import com.esri.arcgis.enterprise.interceptor.server.IServerServicesInterceptorHelper;
import com.esri.arcgis.enterprise.interceptor.IInterceptorConfig;
import com.esri.arcgis.enterprise.interceptor.server.IServerInterceptorLogger;

import jakarta.servlet.ServletException;
import java.io.IOException;

@Interceptor(
		name = "AuditLogInterceptor",
		displayName = "Audit Log Interceptor",
		description = "Audit Log Interceptor",
		urlPatterns = {"/MapServer/","/FeatureServer/"},
		properties = {"prop1=value1"},
		chainingOrder = 1
)
public class AuditLogInterceptor implements IServerServicesInterceptor {
	private IServerServicesInterceptorHelper interceptorHelper;
	private IServerInterceptorLogger logger;

	@Override
	public void init(IInterceptorConfig interceptorConfig,
									IServerServicesInterceptorHelper interceptorHelper,
									IServerInterceptorLogger logger){
		// This code executes at the time of registration
		this.interceptorHelper = interceptorHelper;
		this.logger = logger;
	}

	@Override
	public void intercept(
			IInterceptorRequest request,
			IInterceptorResponse response,
			IServerServicesInterceptorChain filterChain) throws IOException, ServletException {

		// Continue the chain if it's not REST request
		if (!filterChain.isRestRequestChain()) {
			filterChain.intercept(request, response);
			return;
		}

		//To intercept the request, write your code here
		logUserAction(request, response);
		filterChain.intercept(request, response);

		//To intercept the response, write your code here

	}

	/*
	* Perform any cleanup required by the interceptor at the end of its lifecycle
	*/
	@Override
	public void cleanup() {

	}

	private void logUserAction(IInterceptorRequest request, IInterceptorResponse response) {
		String username       = interceptorHelper.getUsername(request, response);
		String serviceName    = interceptorHelper.getServiceName(request, response);
		String serviceType    = interceptorHelper.getServiceType(request, response);
		String serviceProvider= interceptorHelper.getServiceProviderType(request, response);
		String operationName  = interceptorHelper.getOperationName(request, response);

		String msg = "User '" + username + "' "
				+ "accessed the service " + serviceName + "." + serviceType + ". "
				+ "Service provider is " + serviceProvider + ". "
				+ ((operationName != null && !operationName.isEmpty())
				? "Performed the operation - '" + operationName + "'."
				: "");

		logger.info(msg);
	}
}