com.microsoft.azure.storage.file.FileDirectoryProperties Maven / Gradle / Ivy
Show all versions of azure-storage Show documentation
/**
* Copyright Microsoft Corporation
*
* 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 com.microsoft.azure.storage.file;
import java.util.Date;
import java.util.EnumSet;
import com.microsoft.azure.storage.AccessCondition;
/**
* Represents the system properties for a directory.
*/
public final class FileDirectoryProperties {
/**
* Represents the ETag value for the directory.
*/
private String etag;
/**
* Represents the directory's last-modified time.
*/
private Date lastModified;
/**
* Represents the directory's server-side encryption status.
*/
private boolean serverEncrypted;
/**
* The following package private properties are set-able file SMB properties. This is by design.
* There are two variables - one normal variable and one toSet variable to account for the statefulness of our
* objects and the fact that the service requires each SMB property header.
*
* When a user wants to set a new SMB property, they call the setter method, which sets the toSet variable.
* Upon calling the Directory.Create or Directory.SetProperties methods, the toSet variable is checked and set if it has been set to a value.
* The service then returns the properties, that are then populated in the normal variable when updating SMB properties
* and each of the toSet variables are set back to null.
*/
/**
* Represents the directory's permission key.
*/
String filePermissionKey;
/**
* Represents the directory's permission key to set.
*/
String filePermissionKeyToSet;
/**
* Represents the file system attributes for files and directories.
* If not set, indicates preservation of existing values.
*/
EnumSet ntfsAttributes;
/**
* Represents the file system attributes to set for files and directories.
* If not set, indicates preservation of existing values.
*/
EnumSet ntfsAttributesToSet;
/**
* Represents the creation time for the directory.
*/
String creationTime;
/**
* Represents the creation time to set for the directory.
*/
String creationTimeToSet;
/**
* Represents the last-write time for the directory.
*/
String lastWriteTime;
/**
* Represents the last-write time to set for the directory.
*/
String lastWriteTimeToSet;
/**
* Represents the change time for the directory.
*/
private String changeTime;
/**
* Represents the directory's id.
*/
private String fileId;
/**
* Represents the directory's parent id.
*/
private String parentId;
/**
* Gets the ETag value of the directory.
*
* The ETag value is a unique identifier that is updated when a write operation is performed against the directory.
* It may be used to perform operations conditionally, providing concurrency control and improved efficiency.
*
* The {@link AccessCondition#generateIfMatchCondition(String)} and
* {@link AccessCondition#generateIfNoneMatchCondition(String)} methods take an ETag value and return an
* {@link AccessCondition} object that may be specified on the request.
*
* @return A String which represents the ETag.
*/
public String getEtag() {
return this.etag;
}
/**
* Gets the last modified time on the directory.
*
* @return A java.util.Date object which represents the last modified time.
*/
public Date getLastModified() {
return this.lastModified;
}
/**
* Gets the directory's server-side encryption status.
*
* @return A boolean which specifies the directory's encryption status.
*/
public boolean isServerEncrypted() {
return serverEncrypted;
}
/**
* Gets the directory's permission key.
*
* @return A String which specifies the directory's permission key.
*/
public String getFilePermissionKey() {
return this.filePermissionKeyToSet == null ? this.filePermissionKey : this.filePermissionKeyToSet;
}
/**
* Gets the file system attributes for files and directories.
* If not set, indicates preservation of existing values.
*
* @return A {@link NtfsAttributes} object which represents the file system attributes.
*/
public EnumSet getNtfsAttributes() {
return this.ntfsAttributesToSet == null ? this.ntfsAttributes : this.ntfsAttributesToSet;
}
/**
* Gets the creation time for the directory.
*
* @return A String object which represents the creation time.
*/
public String getCreationTime() {
return this.creationTimeToSet == null ? this.creationTime : this.creationTimeToSet;
}
/**
* Gets the last write time for the directory.
*
* @return A String object which represents the last write time.
*/
public String getLastWriteTime() {
return this.lastWriteTimeToSet == null ? this.lastWriteTime : this.lastWriteTimeToSet;
}
/**
* Gets the change time for the directory.
*
* @return A String object which represents the change time.
*/
public String getChangeTime() {
return this.changeTime;
}
/**
* Gets the directory's id.
*
* @return A String which specifies the directory's id.
*/
public String getFileId() {
return this.fileId;
}
/**
* Gets the directory's parent id.
*
* @return A String which specifies the directory's parent id.
*/
public String getParentId() {
return this.parentId;
}
/**
* Sets the ETag value on the directory.
*
* @param etag
* A String which represents the ETag to set.
*/
protected void setEtag(final String etag) {
this.etag = etag;
}
/**
* Sets the directory's server-side encryption status.
*
* @param serverEncrypted
* A boolean which specifies the encryption status to set.
*/
protected void setServerEncrypted(boolean serverEncrypted) {
this.serverEncrypted = serverEncrypted;
}
/**
* Sets the last modified time on the directory.
*
* @param lastModified
* A java.util.Date object which represents the last modified time to set.
*/
protected void setLastModified(final Date lastModified) {
this.lastModified = lastModified;
}
/**
* Sets the directory's permission key.
*
* @param filePermissionKey
* A String which specifies the directory permission key to set.
*/
public void setFilePermissionKey(String filePermissionKey) {
this.filePermissionKeyToSet = filePermissionKey;
}
/**
* Sets the file system attributes for files and directories.
* If not set, indicates preservation of existing values.
*
* @param ntfsAttributes
* A {@link NtfsAttributes} which specifies the file system attributes to set.
*/
public void setNtfsAttributes(EnumSet ntfsAttributes) {
this.ntfsAttributesToSet = ntfsAttributes;
}
/**
* Sets the creation time for the directory.
*
* @param creationTime
* A String object which specifies the creation time to set.
*/
public void setCreationTime(String creationTime) {
this.creationTimeToSet = creationTime;
}
/**
* Sets the last write time for the directory.
*
* @param lastWriteTime
* A String object which specifies the last write time to set.
*/
public void setLastWriteTime(String lastWriteTime) {
this.lastWriteTimeToSet = lastWriteTime;
}
/**
* Sets the change time for the directory.
*
* @param changeTime
* A String object which specifies the change time to set.
*/
protected void setChangeTime(String changeTime) {
this.changeTime = changeTime;
}
/**
* Sets the directory's id.
*
* @param fileId
* A String which specifies the id to set.
*/
protected void setFileId(String fileId) {
this.fileId = fileId;
}
/**
* Sets the directory's parent id.
*
* @param parentId
* A String which specifies the parent id to set.
*/
protected void setParentId(String parentId) {
this.parentId = parentId;
}
}