src/main/java/edu/internet2/middleware/shibboleth/idp/profile/StatusProfileHandler.java

   1 /*
   2  * Licensed to the University Corporation for Advanced Internet Development,
   3  * Inc. (UCAID) under one or more contributor license agreements.  See the
   4  * NOTICE file distributed with this work for additional information regarding
   5  * copyright ownership. The UCAID licenses this file to You under the Apache
   6  * License, Version 2.0 (the "License"); you may not use this file except in
   7  * compliance with the License.  You may obtain a copy of the License at
   8  *
   9  *    http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package edu.internet2.middleware.shibboleth.idp.profile;
  19
  20 import java.io.IOException;
  21 import java.io.OutputStreamWriter;
  22
  23 import org.opensaml.ws.transport.InTransport;
  24 import org.opensaml.ws.transport.OutTransport;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 import edu.internet2.middleware.shibboleth.common.profile.provider.AbstractRequestURIMappedProfileHandler;
  29
  30 /**
  31  * A simple profile handler that returns the string "ok" if the IdP is able to answer the request. This may be used for
  32  * very basic monitoring of the IdP.
  33  *
  34  * @deprecated
  35  */
  36 public class StatusProfileHandler extends AbstractRequestURIMappedProfileHandler {
  37
  38     /** Class logger. */
  39     private final Logger log = LoggerFactory.getLogger(StatusProfileHandler.class);
  40
  41     /** {@inheritDoc} */
  42     public void processRequest(InTransport in, OutTransport out) {
  43         log.warn("This profile handler has been deprecated, use the Status servlet usually located at '/idp/status'");
  44         try {
  45             OutputStreamWriter writer = new OutputStreamWriter(out.getOutgoingStream());
  46             writer.write("ok");
  47             writer.flush();
  48         } catch (IOException e) {
  49             log.error("Unable to write response", e);
  50         }
  51     }
  52 }