software.coolstuff.springframework.owncloud.service.impl.OwncloudProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of owncloud-spring-boot-starter Show documentation

Spring Boot Owncloud Service and Authentication Provider

There is a newer version: 1.5.0

Show newest version

/*-
 * #%L
 * owncloud-spring-boot-starter
 * %%
 * Copyright (C) 2016 - 2017 by the original Authors
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */
package software.coolstuff.springframework.owncloud.service.impl;

import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.logging.LogLevel;
import org.springframework.validation.annotation.Validated;
import software.coolstuff.springframework.owncloud.service.api.OwncloudUserService;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

/**
 * Owncloud Configuration Properties.
 *
 * The Configuration Properties will be implemented by 2 Classes
 * 
 *   software.coolstuff.springframework.owncloud.service.impl.resource.OwncloudResourceProperties

 *       Implements Resource specific Properties
 *   
 *   software.coolstuff.springframework.owncloud.service.impl.rest.OwncloudRestProperties

 *       Implements REST specific Properties
 *   
 * 
 *
 * Within this Class you find the common Properties used by both Implementations
 *
 * @author mufasa1976
 * @since 1.0.0
 */
@Validated
@Getter
@Setter
public abstract class OwncloudProperties {

  /**
   * Default Buffer Size
   * @since 1.2.0
   */
  public static final int DEFAULT_BUFFER_SIZE = 8192;

  /**
   * Common Properties for the UserService
   *
   * @author mufasa1976
   * @since 1.2.0
   */
  @Validated
  @Getter
  @Setter
  public static class UserService {

    /**
     * Should Modifications through {@link OwncloudUserService} be allowed
     * @since 1.2.0
     */
    private boolean enableModifications = true;

  }

  /**
   * Common Resource Service Properties
   *
   * @author mufasa1976
   * @since 1.2.0
   */
  @Validated
  @Getter
  @Setter
  public static class ResourceServiceProperties {

    /**
     * Add ".." to the List of returned OwncloudResources (on list-Methods)
     * @since 1.2.0
     */
    private boolean addRelativeDownPath = true;

    /**
     * Buffer Size for the Copy Process
     * @since 1.2.0
     */
    @Min(1)
    private int pipedStreamBufferSize = DEFAULT_BUFFER_SIZE;

    /**
     * Log-Level of any uncaught Exception while running the Background-Thread of the PipedStream-Synchronizer.
     * @since 1.2.0
     */
    @NotNull
    private LogLevel pipedStreamUncaughtExceptionLogLevel = LogLevel.ERROR;
  }

  /**
   * Location of the Owncloud Instance.
   * 
   * May start with either of these:
   * 
   *   
   *     
   *     
   *   
   *   
   *     
   *     
   *   
   *   
   *     
   *     
   *   
   *   
   *     
   *     
   *   
   * Prefix Usage
classpath: Use a XML-Resource within the Classpath to configure the Owncloud Services
file: Use a XML-Resource outside the Classpath to configure the Owncloud Services
http:// or
https:// Connects to the Owncloud Instance
   * @since 1.0.0
   */
  private String location;

  /**
   * User Service common Properties
   * @since 1.2.0
   */
  private UserService userService = new UserService();

  /**
   * WebDAV common Properties
   * @since 1.2.0
   */
  private ResourceServiceProperties resourceService = new ResourceServiceProperties();
}

Prefix	Usage
`classpath:`	Use a XML-Resource within the Classpath to configure the Owncloud Services
`file:`	Use a XML-Resource outside the Classpath to configure the Owncloud Services
`http://` or `https://`	Connects to the Owncloud Instance