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.eclipse.aether;
20  
21  import java.util.Map;
22  
23  import org.eclipse.aether.artifact.ArtifactTypeRegistry;
24  import org.eclipse.aether.collection.DependencyGraphTransformer;
25  import org.eclipse.aether.collection.DependencyManager;
26  import org.eclipse.aether.collection.DependencySelector;
27  import org.eclipse.aether.collection.DependencyTraverser;
28  import org.eclipse.aether.collection.VersionFilter;
29  import org.eclipse.aether.repository.AuthenticationSelector;
30  import org.eclipse.aether.repository.LocalRepository;
31  import org.eclipse.aether.repository.LocalRepositoryManager;
32  import org.eclipse.aether.repository.MirrorSelector;
33  import org.eclipse.aether.repository.ProxySelector;
34  import org.eclipse.aether.repository.WorkspaceReader;
35  import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
36  import org.eclipse.aether.resolution.ResolutionErrorPolicy;
37  import org.eclipse.aether.transfer.TransferListener;
38  import org.eclipse.aether.transform.FileTransformerManager;
39  
40  /**
41   * A special repository system session to enable decorating or proxying another session. To do so, clients have to
42   * create a subclass and implement {@link #getSession()}, and optionally override other methods.
43   */
44  public abstract class AbstractForwardingRepositorySystemSession implements RepositorySystemSession {
45  
46      /**
47       * Creates a new forwarding session.
48       */
49      protected AbstractForwardingRepositorySystemSession() {}
50  
51      /**
52       * Gets the repository system session to which this instance forwards calls. It's worth noting that this class does
53       * not save/cache the returned reference but queries this method before each forwarding. Hence, the session
54       * forwarded to may change over time or depending on the context (e.g. calling thread).
55       *
56       * @return The repository system session to forward calls to, never {@code null}.
57       */
58      protected abstract RepositorySystemSession getSession();
59  
60      @Override
61      public boolean isOffline() {
62          return getSession().isOffline();
63      }
64  
65      @Override
66      public boolean isIgnoreArtifactDescriptorRepositories() {
67          return getSession().isIgnoreArtifactDescriptorRepositories();
68      }
69  
70      @Override
71      public ResolutionErrorPolicy getResolutionErrorPolicy() {
72          return getSession().getResolutionErrorPolicy();
73      }
74  
75      @Override
76      public ArtifactDescriptorPolicy getArtifactDescriptorPolicy() {
77          return getSession().getArtifactDescriptorPolicy();
78      }
79  
80      @Override
81      public String getChecksumPolicy() {
82          return getSession().getChecksumPolicy();
83      }
84  
85      @Override
86      public String getUpdatePolicy() {
87          return getSession().getUpdatePolicy();
88      }
89  
90      @Override
91      public LocalRepository getLocalRepository() {
92          return getSession().getLocalRepository();
93      }
94  
95      @Override
96      public LocalRepositoryManager getLocalRepositoryManager() {
97          return getSession().getLocalRepositoryManager();
98      }
99  
100     @Override
101     public WorkspaceReader getWorkspaceReader() {
102         return getSession().getWorkspaceReader();
103     }
104 
105     @Override
106     public RepositoryListener getRepositoryListener() {
107         return getSession().getRepositoryListener();
108     }
109 
110     @Override
111     public TransferListener getTransferListener() {
112         return getSession().getTransferListener();
113     }
114 
115     @Override
116     public Map<String, String> getSystemProperties() {
117         return getSession().getSystemProperties();
118     }
119 
120     @Override
121     public Map<String, String> getUserProperties() {
122         return getSession().getUserProperties();
123     }
124 
125     @Override
126     public Map<String, Object> getConfigProperties() {
127         return getSession().getConfigProperties();
128     }
129 
130     @Override
131     public MirrorSelector getMirrorSelector() {
132         return getSession().getMirrorSelector();
133     }
134 
135     @Override
136     public ProxySelector getProxySelector() {
137         return getSession().getProxySelector();
138     }
139 
140     @Override
141     public AuthenticationSelector getAuthenticationSelector() {
142         return getSession().getAuthenticationSelector();
143     }
144 
145     @Override
146     public ArtifactTypeRegistry getArtifactTypeRegistry() {
147         return getSession().getArtifactTypeRegistry();
148     }
149 
150     @Override
151     public DependencyTraverser getDependencyTraverser() {
152         return getSession().getDependencyTraverser();
153     }
154 
155     @Override
156     public DependencyManager getDependencyManager() {
157         return getSession().getDependencyManager();
158     }
159 
160     @Override
161     public DependencySelector getDependencySelector() {
162         return getSession().getDependencySelector();
163     }
164 
165     @Override
166     public VersionFilter getVersionFilter() {
167         return getSession().getVersionFilter();
168     }
169 
170     @Override
171     public DependencyGraphTransformer getDependencyGraphTransformer() {
172         return getSession().getDependencyGraphTransformer();
173     }
174 
175     @Override
176     public SessionData getData() {
177         return getSession().getData();
178     }
179 
180     @Override
181     public RepositoryCache getCache() {
182         return getSession().getCache();
183     }
184 
185     @Override
186     public FileTransformerManager getFileTransformerManager() {
187         return getSession().getFileTransformerManager();
188     }
189 }