Artifactory Java client provides simple yet powerful Artifactory connection and management within your Java code.
The client allows managing Artifactory repositories, users, groups, permissions and system configuration. It also allows searches, upload and download artifacts to or from Artifactory and a lot more.
- Getting Started
- Building and Testing the Sources
- Example Projects
- Contributing Code
- License
- Release Notes
Add the following dependency to your pom.xml file:
<dependency>
<groupId>org.jfrog.artifactory.client</groupId>
<artifactId>artifactory-java-client-services</artifactId>
<version>RELEASE</version>
</dependency>Add the following snippets to your build.gradle file:
repositories {
mavenCentral()
}
dependencies {
compile 'org.jfrog.artifactory.client:artifactory-java-client-services:+'
}This section includes a few usage examples of the Java client APIs from your application code.
Artifactory artifactory = ArtifactoryClientBuilder.create()
.setUrl("ArtifactoryUrl")
.setUsername("username")
.setPassword("password")
.build();Trusting your own self-signed certificates without ignoring any SSL issue:
Artifactory artifactory = ArtifactoryClientBuilder.create()
.setUrl("ArtifactoryUrl")
.setUsername("username")
.setPassword("password")
.setSslContextBuilder(SSLContexts.custom()
.loadTrustMaterial(< your trust strategy here >))
.build();Adding a request interceptor for logging or modifying outgoing requests:
Artifactory artifactory = ArtifactoryClientBuilder.create()
.setUrl("ArtifactoryUrl")
.setUsername("username")
.setPassword("password")
.addInterceptorLast((request, httpContext) -> {
System.out.println("Artifactory request: " + request.getRequestLine());
})
.build();Using HTTP proxy:
ProxyConfig proxy = new ProxyConfig();
proxy.setHost("localhost");
proxy.setPort(9090);
Artifactory artifactory = ArtifactoryClientBuilder.create()
.setUrl("ArtifactoryUrl")
.setUsername("username")
.setPassword("password")
.setProxy(proxy)
.setNoProxyHosts(".gom.com,*.jfrog.com,.not.important.host:443")
.build();NOTE: If hosts to ignore proxy are not set through "setNoProxyHosts(String noProxyHosts)" method, they are set through NO_PROXY env variable.
- Using java.io.File as source:
java.io.File file = new java.io.File("fileToUpload.txt"); File result = artifactory.repository("RepoName").upload("path/to/newName.txt", file).doUpload();
- Using an InputStream as source:
try (InputStream inputStream = Files.newInputStream(Paths.get("fileToUpload.txt"))) { File result = artifactory.repository("RepoName").upload("path/to/newName.txt", inputStream).doUpload(); }
java.io.File file = new java.io.File("fileToUpload.txt");
File result = artifactory.repository("RepoName").upload("path/to/newName.txt", file).doUploadAndExplode(true)java.io.File file = new java.io.File("fileToUpload.txt");
File deployed = artifactory.repository("RepoName")
.upload("path/to/newName.txt", file)
.withProperty("color", "blue")
.withProperty("color", "red")
.doUpload();Can be used for tracking the progress of the current upload:
java.io.File file = new java.io.File("fileToUpload.txt");
File result = artifactory.repository("RepoName")
.upload("path/to/newName.txt", file)
.withListener((bytesRead, totalBytes) -> {
System.out.println("Uploaded " + format.format((double) bytesRead / totalBytes));
})
.doUpload();The code snippet above would print the percentage of the current upload status.
Important: The totalBytes is calculated from the size of the input File. In case the source is a java.io.File object, the upload will use the File.length() to determine the total number of bytes. If the source is an InputStream, the total size of the upload must be specified using the withSize(long size) method.
e.g.:
Path sourceFile = Paths.get("fileToUpload.txt");
try (InputStream inputStream = Files.newInputStream(sourceFile)) {
File result = artifactory.repository("RepoName")
.upload("path/to/newName.txt", inputStream)
.withSize(Files.size(sourceFile))
.withListener((bytesRead, totalBytes) -> {
System.out.println("Uploaded " + format.format((double) bytesRead / totalBytes));
})
.doUpload();
}java.io.File file = new java.io.File("fileToUpload.txt");
String sha1 = calcSha1(file)
File deployed = artifactory.repository("RepoName")
.copyBySha1("path/to/newName.txt", sha1)
.doUpload();InputStream iStream = artifactory.repository("RepoName")
.download("path/to/fileToDownload.txt")
.doDownload();Downloading an Artifact with non-mandatory Properties
InputStream iStream = artifactory.repository("RepoName")
.download("path/to/fileToDownload.txt")
.withProperty("colors", "red")
.doDownload();Downloading Artifact with mandatory properties
InputStream iStream = artifactory.repository("RepoName")
.download("path/to/fileToDownload.txt")
.withMandatoryProperty("colors", "red")
.doDownload();Map<String, String> headers = new HashMap<>();
headers.put("Range", "bytes=0-10");
InputStream iStream = artifactory.repository("RepoName")
.download("path/to/fileToDownload.txt")
.doDownloadWithHeaders(headers);File file = artifactory.repository("RepoName").file("path/to/file.txt").info();
boolean isFile = file.isFolder();
long fileSize = file.getSize();
String fileUri = file.getDownloadUri();
String md5Checksum = file.getChecksums().getMd5();
String sha1Checksum = file.getChecksums().getSha1();
String sha2Checksum = file.getChecksums().getSha256();Folder folder = artifactory.repository("RepoName").folder("path/to/folder").info();
boolean isFolder = folder.isFolder();
String repoName = folder.getRepo();
String folderPath = folder.getPath();
int childrenItemsSize = folder.getChildren().size();Repository repo = artifactory.repository("RepoName").get();
String repoKey = repo.getKey();
String desc = repo.getDescription();
String layout = repo.getRepoLayoutRef();
RepositoryType repoClass = repo.getRclass();
RepositorySettings settings = repo.getRepositorySettings();
PackageType packageType = settings.getPackageType();
if (PackageType.bower == packageType) {
BowerRepositorySettings settingsForBower = (BowerRepositorySettings) settings;
String bowerRegistryUrl = settingsForBower.getBowerRegistryUrl();
}BinariesSummary binariesSummary = artifactory.storage().getStorageInfo().getBinariesSummary();
FileStorageSummary fileStorageSummary = artifactory.storage().getStorageInfo().getFileStoreSummary();
for (RepositorySummary repoSummary : artifactory.storage().getStorageInfo().getRepositoriesSummaryList()) {
repoSummary.getRepoKey();
}Searches repositories(String... repositories);
Searches artifactsByName(String name);
Searches artifactsCreatedSince(long sinceMillis);
Searches artifactsCreatedInDateRange(long fromMillis, long toMillis);
Searches artifactsByGavc();
Searches artifactsLatestVersion();
List<AqlItem> artifactsByFileSpec(FileSpec fileSpec);List<RepoPath> searchItems = artifactory.searches()
.repositories("RepoName", "RepoName2")
.artifactsByName("prefixedWith*.txt")
.doSearch();
for (RepoPath searchItem : searchItems) {
String repoKey = searchItem.getRepoKey();
String itemPath = searchItem.getItemPath();
}List<RepoPath> searchItems = artifactory.searches()
.repositories("RepoName", "RepoName2")
.itemsByProperty()
.property("released")
.property("colors", "r*?")
.doSearch();
for (RepoPath searchItem : searchItems) {
String repoKey = searchItem.getRepoKey();
String itemPath = searchItem.getItemPath();
}List<RepoPath> results = artifactory.searches().artifactsByGavc()
.groupId("com.example")
.artifactId("com.example.test")
.version("1.0.0")
.classifier("zip")
.doSearch();
for (RepoPath searchItem : searchItems) {
String repoKey = searchItem.getRepoKey();
String itemPath = searchItem.getItemPath();
}List<RepoPath> results = artifactory.searches().artifactsByGavc()
.groupId("com.example")
.artifactId("com.example.test")
.repositories("liba-release-local")
.doSearch();
for (RepoPath searchItem : searchItems) {
String repoKey = searchItem.getRepoKey();
String itemPath = searchItem.getItemPath();
}String latestVersion = artifactory.searches().artifactsLatestVersion()
.groupId("com.example")
.artifactId("com.example.test")
.repositories("liba-release-local")
.doRawSearch();FileSpec fileSpec = FileSpec.fromString("{\"files\": [{\"pattern\": \"liba-release-local/*test*\"}]}");
List<AqlItem> results = artifactory.searches().artifactsByFileSpec(fileSpec);AllBuilds allBuilds = artifactory.builds().getAllBuilds();BuildRuns buildRuns = artifactory.builds().getBuildRuns("BuildName");ItemHandle fileItem = artifactory.repository("RepoName").file("path/to/file.txt");
ItemHandle folderItem = artifactory.repository("RepoName").folder("path/to/folder");ItemHandle item =
...
ItemHandle newItem = item.copy("ToRepoName", "path/to/item");ItemHandle item =
...
ItemHandle newItem = item.move("ToRepoName", "path/to/item");String result = artifactory.repository("RepoName").delete("path/to/item");import static org.jfrog.artifactory.client.model.impl.RepositoryTypeImpl.LOCAL;
import static org.jfrog.artifactory.client.model.impl.RepositoryTypeImpl.REMOTE;
import static org.jfrog.artifactory.client.model.impl.RepositoryTypeImpl.VIRTUAL;
import static org.jfrog.artifactory.client.model.impl.RepositoryTypeImpl.FEDERATED;
...
List<LightweightRepository> localRepoList = artifactory.repositories().list(LOCAL);
List<LightweightRepository> remoteRepoList = artifactory.repositories().list(REMOTE);
List<LightweightRepository> virtualRepoList = artifactory.repositories().list(VIRTUAL);
List<LightweightRepository> federatedRepoList = artifactory.repositories().list(FEDERATED);DebianRepositorySettingsImpl settings = new DebianRepositorySettingsImpl();
settings.setDebianTrivialLayout(true);
Repository repository = artifactory.repositories()
.builders()
.localRepositoryBuilder()
.key("NewRepoName")
.description("new local repository")
.repositorySettings(settings)
.build();
String result = artifactory.repositories().create(2, repository);DockerRepositorySettings settings = new DockerRepositorySettingsImpl();
List<FederatedMember> federatedMembers = new ArrayList<FederatedMember>();
FederatedMember federatedMember = new FederatedMember("http://<JPDURL>/artifactory/"+NewRepoName, true);
federatedMembers.add(federatedMember);
Repository repository = artifactory.repositories()
.builders()
.federatedRepositoryBuilder()
.members(federatedMembers)
.key("NewRepoName")
.description("new federated repository")
.repositorySettings(settings)
.build();
String result = artifactory.repositories().create(2, repository);For choosing your repository characteristic, use the right settings, each one of them possess the relevant attributes available in Artifactory.
Example for using generic repository with maven layout:
RepositorySettings settings = new GenericRepositorySettingsImpl()
settings.setRepoLayout("maven-2-default")Repository repository = artifactory.repository("RepoName").get();
RepositorySettings settings = repository.getRepositorySettings();
if (PackageType.debian == settings.getPackageType()) {
DebianRepositorySettingsImpl settingsForDebian = (DebianRepositorySettingsImpl) settings;
settingsForDebian.setDebianTrivialLayout(false);
}
Repository updatedRepository = artifactory.repositories()
.builders()
.builderFrom(repository)
.description("new_description")
.build();
String result = artifactory.repositories().update(updatedRepository);String result = artifactory.repository("RepoName").delete();// Method supported for local and remote repositories
artifactory.repository("RepoName").replications.delete()LocalReplication replication = new LocalReplicationBuilderImpl()
.url("http://hostname1:port/artifactory/RepoName")
.socketTimeoutMillis(30000)
.username("john.doe")
.password("secret")
.enableEventReplication(false)
.enabled(false)
.cronExp("0 0 0/2 * * ?")
.syncDeletes(true)
.syncProperties(true)
.syncStatistics(true)
.pathPrefix("")
.repoKey("RepoName")
.build();
artifactory.repository("RepoName").getReplications().createOrReplace(replication);RemoteReplication replication = new RemoteReplicationBuilderImpl()
.enabled(false)
.cronExp("0 0 0/2 * * ?")
.syncDeletes(true)
.syncProperties(true)
.repoKey("RepoName")
.build();
artifactory.repository("RepoName").getReplications().createOrReplace(replication)Repository repository = artifactory.repository("RepoName").get();
XraySettings xraySettings = repository.getXraySettings();
xraySettings.setXrayIndex(true)
Repository updatedRepository = artifactory.repositories()
.builders()
.builderFrom(repository)
.description("new_description")
.build();
String result = artifactory.repositories().update(updatedRepository);CustomPackageTypeImpl customPackageType = new CustomPackageTypeImpl("name");
CustomRepositorySettingsImpl settings = new CustomRepositorySettingsImpl(customPackageType);
Map<String, Object> customProperties = new HashMap<>();
customProperties.put("key", "value");
Repository repository = artifactory.repositories()
.builders()
.localRepositoryBuilder()
.key("NewRepoName")
.description("new local repository")
.repositorySettings(settings)
.customProperties(customProperties)
.build();
String result = artifactory.repositories().create(2, repository);A smart remote repository is a remote repository that proxies a repository from another instance of Artifactory. Smart remote repositories are configured with four additional properties.
RemoteRepository remoteRepository = (RemoteRepository) artifactory.repository("SmartRemoteRepoName").get();
ContentSync contentSync = remoteRepository.getContentSync();
contentSync.setEnabled(true);
// Report Statistics
contentSync.getStatistics().setEnabled(true);
// Sync Properties
contentSync.getProperties().setEnabled(true);
// Source Absence Detection
contentSync.getSource().setOriginAbsenceDetection(true);
Repository updatedRepository = artifactory.repositories()
.builders()
.builderFrom(remoteRepository)
.listRemoteFolderItems(true) // List Remote Folder Items
.build();
String result = artifactory.repositories().update(updatedRepository);User user = artifactory.security().user("userName");
String name = user.getName();
String email = user.getEmail();
Collection<String> groups = user.getGroups();
Date loggedIn = user.getLastLoggedIn();
boolean profileUpdatable = user.isProfileUpdatable();
boolean isAdmin = user.isAdmin();
boolean internalPass = user.isInternalPasswordDisabled();
String realm = user.getRealm();Collection<String> userNames = artifactory.security().userNames();
for (String userName : userNames) {
User user = artifactory.security().user(userName);
}UserBuilder userBuilder = artifactory.security().builders().userBuilder();
User user = userBuilder.name("userName")
.email("[email protected]")
.admin(false)
.profileUpdatable(true)
.password("password")
.build();
artifactory.security().createOrUpdate(user);String result = artifactory.security().deleteUser("userName");Group group = artifactory.security().group("groupName");
String description = group.getDescription();
boolean isAutoJoin = group.isAutoJoin();
boolean isAdminPrivileges = group.isAdminPrivileges();List<String> groupNames = artifactory.security().groupNames();
for (String groupName : groupNames) {
Group group = artifactory.security().group(groupName);
}Group group = artifactory.security().builders().groupBuilder()
.name("groupName")
.autoJoin(true)
.adminPrivileges(true)
.description("new group")
.build();
artifactory.security().createOrUpdateGroup(group);When using LDAP integration or realm User plugin, it could be interesting to preload groups (and permissions) before any user login :
String realmAttributes = "ldapGroupName=groupName;groupsStrategy=STATIC;groupDn=cn=GROUPNAME,ou=foo,o=bar";
Group group = artifactory.security().builders().groupBuilder()
.name("groupName")
.description("GROUPNAME")
.realm("ldap")
.realmAttributes(realmAttributes)
.build();
artifactory.security().createOrUpdateGroup(group);NB: The realmAttributes depends of realm implementation ; so firstly, use LDAP Groups Synchronization to import some groups manually in Artifactory, and analyse a JSON GET on one of this/these group(s) to understand the content of realmAttributes parameter.
artifactory.security().deleteGroup("groupName");Set<ItemPermission> itemPermissions = artifactory.repository("RepoName")
.file("path/to/file.txt")
.effectivePermissions();
for (ItemPermission itemPermission : itemPermissions) {
RepoPath repoPath = itemPermissions.getRepoPath();
List<Privilege> privileges = getPrivileges();
Subject subject = getSubject();
boolean isAllowedTo = isAllowedTo(ADMIN, DELETE, DEPLOY, ANNOTATE, READ);
}PermissionTarget permissionTarget = artifactory.security().permissionTarget("permissionName");
String name = permissionTarget.getName()
);
String exclude = permissionTarget.getExcludesPattern();
String include = permissionTarget.getIncludesPattern();
List<String> repos = permissionTarget.getRepositories();
List<ItemPermission> perm = permissionTarget.getItemPermissions();List<String> permissionTargetNames = artifactory.security().permissionTargets();
for (String permissionTargetName : permissionTargetNames) {
PermissionTarget permissionTarget = artifactory.security().permissionTarget(permissionTargetName);
}Principal userAdmin = artifactory.security().builders().principalBuilder()
.name("admin")
.privileges(Privilege.ADMIN)
.build();
Principal groupTest = artifactory.security().builders().principalBuilder()
.name("myTest")
.privileges(Privilege.DEPLOY, Privilege.READ)
.build();
Principals principals = artifactory.security().builders().principalsBuilder()
.users(userAdmin)
.groups(groupTest)
.build();
PermissionTarget permissionTarget = artifactory.security().builders().permissionTargetBuilder()
.name("myPermission")
.principals(principals)
.repositories("some-repository")
.includesPattern("com/company/**,org/public/**")
.build();
artifactory.security().createOrReplacePermissionTarget(permissionTarget);Version version = artifactory.system().version();
String version = version.getVersion();
String revision = version.getRevision();
String license = version.getLicense();
List<String> addons = version.getAddons();String xml = artifactory.system().configuration();artifactory.system().configuration(xml);String yaml = artifactory.system().yamlConfiguration();artifactory.system().yamlConfiguration(yaml);Executing an Artifactory REST API
ArtifactoryRequest repositoryRequest = new ArtifactoryRequestImpl().apiUrl("api/repositories")
.method(ArtifactoryRequest.Method.GET)
.responseType(ArtifactoryRequest.ContentType.JSON);
ArtifactoryResponse response = artifactory.restCall(repositoryRequest);
// Get the response headers
org.apache.http.Header[] headers = response.getAllHeaders();
// Get the response status information
org.apache.http.StatusLine statusLine = response.getStatusLine();
// A convenience method for verifying success
assert response.isSuccessResponse();
// Get the response raw body
String rawBody = response.getRawBody();
// If the the response raw body has a JSON format, populate an object with the body content,
// by providing a object's class.
List<Map<String, String>> parsedBody = response.parseBody(List.class);Executing an Artifactory streaming REST API
ArtifactoryRequest repositoryRequest = new ArtifactoryRequestImpl().apiUrl("api/repositories")
.method(ArtifactoryRequest.Method.GET)
.responseType(ArtifactoryRequest.ContentType.JSON);
ArtifactoryStreamingResponse response = artifactory.streamingRestCall(repositoryRequest);
// Get the response headers
org.apache.http.Header[] headers = response.getAllHeaders();
// Get the response status information
org.apache.http.StatusLine statusLine = response.getStatusLine();
// A convenience method for verifying success
assert response.isSuccessResponse();
// Get the response raw body using input stream
String rawBody = IOUtils.toString(response.getInputStream(), StandardCharsets.UTF_8);The code is built using Gradle and includes integration tests.
Since the tests may use features which have been recently added to Artifactory, such as new package types, it is best to run the tests against the latest release of Artifactory. Some tests may therefore fail otherwise. Those tests can be manually commented out in that case.
If you'd like to build the code without tests, run:
gradle clean build -x testPlease follow these steps to build and test the code:
- Startup an Artifactory-Pro instance.
- Set the CLIENTTESTS_ARTIFACTORY_URL, CLIENTTESTS_ARTIFACTORY_USERNAME and CLIENTTESTS_ARTIFACTORY_PASSWORD environment variables with your Artifactory URL, username and password.
- Run:
gradle clean testWe created sample projects demonstrating how to use the Artifactory Java Client.
We welcome community contribution through pull requests.
- If the existing tests do not already cover your changes, please add tests..
- Pull requests should be created on the dev branch.
This client is available under the Apache License, Version 2.0.
The release notes are available here.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent