View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.orchestra.conversation;
20  
21  import java.util.Set;
22  
23  /**
24   * Provides configuration information to a AccessScopeManager instance.
25   * <p>
26   * While an AccessScopeManager object is expected to be request-scoped, an instance
27   * of this type is usually application-scoped (aka singleton scoped).
28   * 
29   * @since 1.1
30   */
31  public class AccessScopeManagerConfiguration
32  {
33      private Set ignoreViewIds;
34  
35      public Set getIgnoreViewIds()
36      {
37          return ignoreViewIds;
38      }
39  
40      /**
41       * Do not terminate any "unaccessed conversations" after handling a request to
42       * any of the specified views.
43       * 
44       * Special "ignored views" are useful when dealing with things like nested
45       * frames within a page that periodically refresh themselves while the "main"
46       * part of the page remains unsubmitted.
47       */
48      public void setIgnoreViewIds(Set ignoreViewIds)
49      {
50          this.ignoreViewIds = ignoreViewIds;
51      }
52  }