Synch with new profile handler class hierarchy
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / profile / StatusProfileHandler.java
1 /*
2  * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package edu.internet2.middleware.shibboleth.idp.profile;
18
19 import java.io.IOException;
20 import java.io.PrintWriter;
21
22 import javax.servlet.ServletRequest;
23 import javax.servlet.ServletResponse;
24
25 import org.apache.log4j.Logger;
26
27 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
28 import edu.internet2.middleware.shibboleth.common.profile.ProfileRequest;
29 import edu.internet2.middleware.shibboleth.common.profile.ProfileResponse;
30 import edu.internet2.middleware.shibboleth.common.profile.provider.AbstractRequestURIMappedProfileHandler;
31
32 /**
33  * A simple profile handler that returns the string "ok" if the IdP is able to answer the request. This may be used for
34  * very basic monitoring of the IdP.
35  */
36 public class StatusProfileHandler extends AbstractRequestURIMappedProfileHandler {
37
38     /** Class logger. */
39     private final Logger log = Logger.getLogger(StatusProfileHandler.class);
40
41     /** {@inheritDoc} */
42     public String getProfileId() {
43         return "urn:mace:shibboleth:2.0:idp:profiles:status";
44     }
45
46     /** {@inheritDoc} */
47     public void processRequest(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response)
48             throws ProfileException {
49         try {
50             PrintWriter out = response.getRawResponse().getWriter();
51             out.write("ok");
52         } catch (IOException e) {
53             log.error("Unable to write response", e);
54         }
55     }
56 }