001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.camel.component.jms;
018    
019    /**
020     * Strategy for applying encoding and decoding of JMS headers so they apply to the JMS spec.
021     *
022     * @version $Revision: 3055 $
023     */
024    public interface JmsKeyFormatStrategy {
025    
026        /**
027         * Encodes the key before its sent as a {@link javax.jms.Message} message.
028         *
029         * @param key  the original key
030         * @return the encoded key
031         */
032        String encodeKey(String key);
033    
034        /**
035         * Decodes the key after its received from a {@link javax.jms.Message} message.
036         *
037         * @param key the encoded key
038         * @return the decoded key as the original key
039         */
040        String decodeKey(String key);
041    }