1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
|
/*
* Copyright 2007 - 2018 ETH Zuerich, CISD and SIS.
*
* 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 ch.systemsx.cisd.hdf5.h5ar;
import ch.systemsx.cisd.base.unix.FileLinkType;
/**
* A class to describe a new (yet to be created) archive entry.
*
* @author Bernd Rinn
*/
public abstract class NewArchiveEntry
{
private final String parentPath;
private final String name;
private final FileLinkType linkType;
private final String linkTarget;
private long lastModified;
private int uid;
private int gid;
private short permissions;
private long size;
private int crc32;
/**
* A class to describe a new regular file archive entry.
*/
public static final class NewFileArchiveEntry extends NewArchiveEntry
{
private boolean compress;
private int chunkSize;
private NewFileArchiveEntry(String parentPath, String name)
{
super(parentPath, name, FileLinkType.REGULAR_FILE, null);
}
@Override
public NewFileArchiveEntry lastModified(long lastModified)
{
super.lastModified(lastModified);
return this;
}
@Override
public NewFileArchiveEntry uid(int uid)
{
super.uid(uid);
return this;
}
@Override
public NewFileArchiveEntry gid(int gid)
{
super.gid(gid);
return this;
}
@Override
public NewFileArchiveEntry permissions(short permissions)
{
super.permissions(permissions);
return this;
}
public NewFileArchiveEntry compress()
{
this.compress = true;
return this;
}
public NewFileArchiveEntry compress(@SuppressWarnings("hiding")
boolean compress)
{
this.compress = compress;
return this;
}
public boolean isCompress()
{
return compress;
}
/**
* @param chunkSize The chunk size of the file in the archive. Will be capped to 10MB.
*/
public NewFileArchiveEntry chunkSize(@SuppressWarnings("hiding")
int chunkSize)
{
this.chunkSize = chunkSize;
return this;
}
public int getChunkSize()
{
return chunkSize;
}
}
/**
* A class to describe a new symlink archive entry.
*/
public static final class NewSymLinkArchiveEntry extends NewArchiveEntry
{
private NewSymLinkArchiveEntry(String parentPath, String name, String linkTarget)
{
super(parentPath, name, FileLinkType.SYMLINK, linkTarget);
}
@Override
public NewSymLinkArchiveEntry lastModified(long lastModified)
{
super.lastModified(lastModified);
return this;
}
@Override
public NewSymLinkArchiveEntry uid(int uid)
{
super.uid(uid);
return this;
}
@Override
public NewSymLinkArchiveEntry gid(int gid)
{
super.gid(gid);
return this;
}
@Override
public NewSymLinkArchiveEntry permissions(short permissions)
{
super.permissions(permissions);
return this;
}
}
/**
* A class to describe a new directory archive entry.
*/
public static final class NewDirectoryArchiveEntry extends NewArchiveEntry
{
private NewDirectoryArchiveEntry(String parentPath, String name)
{
super(parentPath, name, FileLinkType.DIRECTORY, null);
}
@Override
public NewDirectoryArchiveEntry lastModified(long lastModified)
{
super.lastModified(lastModified);
return this;
}
@Override
public NewDirectoryArchiveEntry uid(int uid)
{
super.uid(uid);
return this;
}
@Override
public NewDirectoryArchiveEntry gid(int gid)
{
super.gid(gid);
return this;
}
@Override
public NewDirectoryArchiveEntry permissions(short permissions)
{
super.permissions(permissions);
return this;
}
}
/**
* @param path The path of the file in the archive.
*/
public static NewFileArchiveEntry file(String path)
{
final String normalizedPath = Utils.normalizePath(path);
final String parentPath = Utils.getParentPath(normalizedPath);
final String name = Utils.getName(normalizedPath);
if (name.length() == 0)
{
throw new ArchivingException(path, "Path does not contain a name.");
}
return new NewFileArchiveEntry(parentPath, name);
}
/**
* @param parentPath The parent path of the file in the archive.
* @param name The name of the file in the archive.
*/
public static NewFileArchiveEntry file(String parentPath, String name)
{
return new NewFileArchiveEntry(parentPath, name);
}
/**
* @param path The path of the symlink in the archive.
* @param linkTarget the link target of the symlink.
*/
public static NewSymLinkArchiveEntry symlink(String path, String linkTarget)
{
final String normalizedPath = Utils.normalizePath(path);
final String parentPath = Utils.getParentPath(normalizedPath);
final String name = Utils.getName(normalizedPath);
if (name.length() == 0)
{
throw new ArchivingException(path, "Path does not contain a name.");
}
return new NewSymLinkArchiveEntry(parentPath, name, linkTarget);
}
public static NewSymLinkArchiveEntry symlink(String parentPath, String name, String linkTarget)
{
return new NewSymLinkArchiveEntry(parentPath, name, linkTarget);
}
public static NewDirectoryArchiveEntry directory(String path)
{
final String normalizedPath = Utils.normalizePath(path);
final String parentPath = Utils.getParentPath(normalizedPath);
final String name = Utils.getName(normalizedPath);
if (name.length() == 0)
{
throw new ArchivingException(path, "Path does not contain a name.");
}
return new NewDirectoryArchiveEntry(parentPath, name);
}
public static NewDirectoryArchiveEntry directory(String parentPath, String name)
{
return new NewDirectoryArchiveEntry(parentPath, name);
}
private NewArchiveEntry(String parentPath, String name, FileLinkType linkType, String linkTarget)
{
this.parentPath = Utils.normalizePath(parentPath);
this.name = name;
this.linkType = linkType;
this.linkTarget = linkTarget;
this.size = Utils.UNKNOWN;
this.lastModified = System.currentTimeMillis() / 1000;
this.uid = Utils.getCurrentUid();
this.gid = Utils.getCurrentGid();
this.permissions = 0755;
}
public String getParentPath()
{
return parentPath;
}
public long getLastModified()
{
return lastModified;
}
public NewArchiveEntry lastModified(@SuppressWarnings("hiding")
long lastModified)
{
this.lastModified = lastModified;
return this;
}
public int getUid()
{
return uid;
}
public NewArchiveEntry uid(@SuppressWarnings("hiding")
int uid)
{
this.uid = uid;
return this;
}
public int getGid()
{
return gid;
}
public NewArchiveEntry gid(@SuppressWarnings("hiding")
int gid)
{
this.gid = gid;
return this;
}
public short getPermissions()
{
return permissions;
}
public NewArchiveEntry permissions(@SuppressWarnings("hiding")
short permissions)
{
this.permissions = permissions;
return this;
}
public int getCrc32()
{
return crc32;
}
void setCrc32(int crc32)
{
this.crc32 = crc32;
}
public String getName()
{
return name;
}
public FileLinkType getLinkType()
{
return linkType;
}
public String getLinkTarget()
{
return linkTarget;
}
public long getSize()
{
return size;
}
void setSize(long size)
{
this.size = size;
}
}
|