net.sourceforge.jwbf.actions.mw.util.MWAction.java Source code

Introduction

Here is the source code for net.sourceforge.jwbf.actions.mw.util.MWAction.java

Source

/*
 * Copyright 2007 Thomas Stock.
 * 
 * Licensed 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.
 * 
 * Contributors:
 * 
 */
package net.sourceforge.jwbf.actions.mw.util;

import java.io.UnsupportedEncodingException;
import java.util.List;
import java.util.Vector;

import net.sourceforge.jwbf.actions.ContentProcessable;
import net.sourceforge.jwbf.bots.MediaWikiBot;

import org.apache.commons.httpclient.Cookie;
import org.apache.commons.httpclient.HttpMethod;

/**
 * @author Thomas Stock
 *
 */
public abstract class MWAction implements ContentProcessable {

    protected List<HttpMethod> msgs;

    /**
     * 
     * 
     */
    public MWAction() {
        msgs = new Vector<HttpMethod>();

    }

    /**
     * 
     * @return a
     */
    public final List<HttpMethod> getMessages() {
        return msgs;
    }

    /**
     * @param s
     *            the returning text
     * @param hm
     *            the method object
     * @return the returning text
     * @throws ProcessException on processing problems
     * 
     */
    public String processReturningText(final String s, final HttpMethod hm) throws ProcessException {
        return processAllReturningText(s);
    }

    /**
     * @param cs
     *            a
     * @param hm
     *            the method object
     * @throws CookieException
     *             never
     * 
     */
    public void validateReturningCookies(Cookie[] cs, HttpMethod hm) throws CookieException {
        validateAllReturningCookies(cs);

    }

    /**
     * @param cs
     *            a
     * @throws CookieException
     *             never
     * 
     */
    public void validateAllReturningCookies(final Cookie[] cs) throws CookieException {
        // do nothing
    }

    /**
     * @param s
     *            the returning text
     * @return the returning text
     * @throws ProcessException never
     * 
     */
    public String processAllReturningText(final String s) throws ProcessException {
        return s;
    }

    /**
     * changes to mediawiki default encoding.
     * @param s a
     * @return encoded s
     * @deprecated
     * TODO delete Method
     */
    protected String encodeUtf8(final String s) {

        try {
            return new String(s.getBytes(), MediaWikiBot.CHARSET);
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        } catch (NullPointerException npe) {
            return s;
        }
        return s;

        //      java 1.6 version
        //      return new String(s.getBytes(), Charset.forName("UTF-8"));
    }

}