code: /**
   * 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.cxf.ws.security.wss4j.policyvalidators;
  
  import org.apache.cxf.message.Message;
  import org.apache.cxf.message.MessageUtils;
  import org.apache.cxf.ws.security.policy.SPConstants.IncludeTokenType;
  import org.apache.cxf.ws.security.policy.model.Token;
  
  /**
   * Some abstract functionality for validating a Security Token.
   */
  public abstract class AbstractTokenPolicyValidator {
      
      /**
       * Check to see if a token is required or not.
       * @param token the token
       * @param message The message
       * @return true if the token is required
       */
      protected boolean isTokenRequired(
          Token token,
          Message message
      ) {
          IncludeTokenType inclusion = token.getInclusion();
          if (inclusion == IncludeTokenType.INCLUDE_TOKEN_NEVER) {
              return false;
          } else if (inclusion == IncludeTokenType.INCLUDE_TOKEN_ALWAYS) {
              return true;
          } else {
              boolean initiator = MessageUtils.isRequestor(message);
              if (initiator && (inclusion == IncludeTokenType.INCLUDE_TOKEN_ALWAYS_TO_INITIATOR)) {
                  return true;
              } else if (!initiator && (inclusion == IncludeTokenType.INCLUDE_TOKEN_ONCE
                  || inclusion == IncludeTokenType.INCLUDE_TOKEN_ALWAYS_TO_RECIPIENT)) {
                  return true;
              }
              return false;
          }
      }
      
  }
  