BinaryResponse.java

/*
 * Copyright (c) 2016, Inversoft Inc., All Rights Reserved
 *
 * 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 org.primeframework.mvc.content.binary.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import org.primeframework.mvc.action.result.annotation.Binary;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * This result writes out a member marked with this annotation to the response with the <code>Content-Type</code> set
 * to <code>application/octet-stream</code>. This annotation should be used with {@link Binary} action annotation.
 *
 * @author Daniel DeGroff
 */
@Retention(RUNTIME)
@Target({FIELD, METHOD})
public @interface BinaryResponse {

  /**
   * Default is true. When true prime will delete the file annotated with {@link BinaryResponse} once it is
   * successfully written the contents to the output stream. If you do not want the file deleted or wish to handle it
   * yourself set this parameter to false.
   *
   * @return true or false
   */
  boolean deleteUponCompletion() default true;
}