com.bitplan.mediawiki.japi.api.Api Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mediawiki-japi Show documentation
Java library to call Mediawiki API described at http://www.mediawiki.org/wiki/API:Main_page
There is a newer version: 0.2.3
/**
 *
 * This file is part of the https://github.com/WolfgangFahl/Mediawiki-Japi open source project
 *
 * Copyright 2015-2017 BITPlan GmbH https://github.com/BITPlan
 *
 * 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.
 */
package com.bitplan.mediawiki.japi.api;

import java.util.logging.Level;

import javax.xml.bind.JAXBException;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;

import com.bitplan.mediawiki.japi.jaxb.JaxbFactory;
import com.bitplan.mediawiki.japi.jaxb.JaxbFactoryApi;
import com.bitplan.mediawiki.japi.jaxb.JaxbPersistenceApi;

/**
 * Mediawiki Api Jaxb wrapper
 * 
 * see Mediawiki
 * API:Main_page
 * 
 * @author wf
 *
 */
@XmlRootElement(name = "api")
public class Api implements JaxbPersistenceApi {
	 /**
   * Logging may be enabled by setting debug to true
   */
  protected static java.util.logging.Logger LOGGER = java.util.logging.Logger
      .getLogger("com.bitplan.mediawiki.japi.api");
  
  String servedby;
  protected Query query;
  protected Login login;
  protected Error error;
  protected Createaccount createaccount;
 
  protected Warnings warnings;
  protected Tokens tokens;
  protected Edit edit;
  protected Delete delete;
  protected Parse parse;
  protected Paraminfo paraminfo;

  /**
   * Ruft den Wert der paraminfo-Eigenschaft ab.
   * 
   * @return
   *     possible object is
   *     {@link Paraminfo }
   *     
   */
  public Paraminfo getParaminfo() {
      return paraminfo;
  }

  /**
   * Legt den Wert der paraminfo-Eigenschaft fest.
   * 
   * @param value
   *     allowed object is
   *     {@link Paraminfo }
   *     
   */
  public void setParaminfo(Paraminfo value) {
      this.paraminfo = value;
  }

  /**
   * @return the servedby
   */
  @XmlAttribute
  public String getServedby() {
    return servedby;
  }

  /**
   * @param servedby
   *          the servedby to set
   */
  public void setServedby(String servedby) {
    this.servedby = servedby;
  }

  /**
   * Gets the value of the login property.
   * 
   * @return possible object is {@link Login }
   * 
   */
  public Login getLogin() {
    return login;
  }

  /**
   * Sets the value of the login property.
   * 
   * @param value
   *          allowed object is {@link Login }
   * 
   */
  public void setLogin(Login value) {
    this.login = value;
  }

  /**
   * @return the query
   */
  public Query getQuery() {
    return query;
  }

  /**
   * @param query
   *          the query to set
   */
  public void setQuery(Query query) {
    this.query = query;
  }

  /**
   * Gets the value of the error property.
   * 
   * @return possible object is {@link Error }
   * 
   */
  public Error getError() {
    return error;
  }

  /**
   * Sets the value of the error property.
   * 
   * @param value
   *          allowed object is {@link Error }
   * 
   */
  public void setError(Error value) {
    this.error = value;
  }

  /**
   * Ruft den Wert der warnings-Eigenschaft ab.
   * 
   * @return possible object is {@link Warnings }
   * 
   */
  public Warnings getWarnings() {
    return warnings;
  }

  /**
   * Legt den Wert der warnings-Eigenschaft fest.
   * 
   * @param value
   *          allowed object is {@link Warnings }
   * 
   */
  public void setWarnings(Warnings value) {
    this.warnings = value;
  }

  /**
   * Gets the value of the tokens property.
   * 
   * @return possible object is {@link Tokens }
   * 
   */
  public Tokens getTokens() {
    return tokens;
  }

  /**
   * Sets the value of the tokens property.
   * 
   * @param value
   *          allowed object is {@link Tokens }
   * 
   */
  public void setTokens(Tokens value) {
    this.tokens = value;
  }
  
  /**
   * Ruft den Wert der createaccount-Eigenschaft ab.
   * 
   * @return
   *     possible object is
   *     {@link Createaccount }
   *     
   */
  public Createaccount getCreateaccount() {
      return createaccount;
  }

  /**
   * Legt den Wert der createaccount-Eigenschaft fest.
   * 
   * @param value
   *     allowed object is
   *     {@link Createaccount }
   *     
   */
  public void setCreateaccount(Createaccount value) {
      this.createaccount = value;
  }

  /**
   * Gets the value of the edit property.
   * 
   * @return possible object is {@link Edit }
   * 
   */
  public Edit getEdit() {
    return edit;
  }

  /**
   * @return the delete
   */
  public Delete getDelete() {
    return delete;
  }

  /**
   * @param delete the delete to set
   */
  public void setDelete(Delete delete) {
    this.delete = delete;
  }

  /**
   * Sets the value of the edit property.
   * 
   * @param value
   *          allowed object is {@link Edit }
   * 
   */
  public void setEdit(Edit value) {
    this.edit = value;
  }

  /**
   * Gets the value of the parse property.
   * 
   * @return possible object is {@link Parse }
   * 
   */
  public Parse getParse() {
    return parse;
  }

  /**
   * Sets the value of the parse property.
   * 
   * @param value
   *          allowed object is {@link Parse }
   * 
   */
  public void setParse(Parse value) {
    this.parse = value;
  }
  
  /**
   * allows typed / non static access to JaxbFactory features for
   * 
   * @author wf
   *
   */
  public static class ApiFactory extends JaxbFactory {
    public ApiFactory() {
      super(Api.class);
    }
  }

  private static ApiFactory apifactory = new ApiFactory();

  /**
   * create a Api from an XML string
   * 
   * @param xml
   *          - xml representation of Page Schema
   * @return the Api unmarshalled from the given xml
   * @throws Exception
   */
  public static Api fromXML(final String xml) throws Exception {
  	Api result=null;
  	try {
  	  result=apifactory.fromXML(xml);
  	} catch (JAXBException je) {
  		LOGGER.log(Level.SEVERE,je.getMessage());
  		LOGGER.log(Level.INFO,xml);
  		throw je;
  	}
    return result;
  }

  /**
   * get my factory
   * 
   * @return the factory
   */
  public JaxbFactoryApi getFactory() {
    return apifactory;
  }

  /**
   * return me as a Json string
   */
  public String asJson() throws JAXBException {
    return getFactory().asJson(this);
  }

  /**
   * return me as an Xml string
   */
  public String asXML() throws JAXBException {
    return getFactory().asXML(this);
  }

}