{"id":22422117,"url":"https://github.com/abumq/residue-java","last_synced_at":"2025-10-13T19:03:19.609Z","repository":{"id":36285826,"uuid":"98844840","full_name":"abumq/residue-java","owner":"abumq","description":"Official Java client library to interact with residue logging server seamlessly.","archived":false,"fork":false,"pushed_at":"2023-07-20T04:17:41.000Z","size":302,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-01T10:27:42.313Z","etag":null,"topics":["android-library","android-logger","java","java-library","logging-library","remote-logging","residue","residue-client","residue-tools"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abumq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-31T03:34:05.000Z","updated_at":"2024-04-05T22:40:55.000Z","dependencies_parsed_at":"2024-12-05T17:11:50.660Z","dependency_job_id":null,"html_url":"https://github.com/abumq/residue-java","commit_stats":null,"previous_names":["abumq/residue-java"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abumq%2Fresidue-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abumq%2Fresidue-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abumq%2Fresidue-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abumq%2Fresidue-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abumq","download_url":"https://codeload.github.com/abumq/residue-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245786743,"owners_count":20671802,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android-library","android-logger","java","java-library","logging-library","remote-logging","residue","residue-client","residue-tools"],"created_at":"2024-12-05T17:11:46.186Z","updated_at":"2025-10-13T19:03:14.576Z","avatar_url":"https://github.com/abumq.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"﷽\n\n# Residue Java Client\n\n[![Version](https://img.shields.io/github/release/abumq/residue-java.svg)](https://github.com/abumq/residue-java/releases/latest) [![GitHub license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/abumq/residue-java/blob/master/LICENCE)\n\n## Introduction\nThis library provides you interface to connect to the residue seamlessly and use it as your central logging library.\n\nPlease note, until first stable release we are not providing JAR file for this library. Please feel free to import the relevant code in to your library.\n\nFor regular java project you will need [Residue.java](/src/com/abumq/residue) and [Base64.java](/src/com/abumq/residue/Base64.java)\n\nFor android project you will also need [ResidueConnectTask.java](/src/com/abumq/residue/ResidueConnectTask.java)\n\n## Dependencies\n\n * [BouncyCastle](http://www.bouncycastle.org/) 1.56+\n * [Gson](https://github.com/google/gson) v2.6.2+\n * [API level 26](https://developer.android.com/about/versions/oreo/android-8.0.html) for Android\n\n### Download Dependencies\n\n```\nmkdir lib\nwget https://abumq.github.io/downloads/bcprov-jdk15on-156.jar -O lib/bcprov-jdk15on-156.jar ## BouncyCastle\nwget https://abumq.github.io/downloads/gson-2.6.2.jar -O lib/gson-2.6.2.jar ## GSON\n```\n\n### Higher security\n\nYou may be interested in Unlimited Strength Jurisdiction Policy Files for higher security and ability to use AES-256 cryptography. Please make sure you read the policy statement.\n\nYou can [download it from here](https://abumq.github.io/downloads/UnlimitedJCEPolicyJDK7.zip) and make sure you unzip these files to `\u003cjava-home\u003e/jre/lib/security` (please make backups as required).\n\n#### Official Links\n\n* BouncyCastle: https://www.bouncycastle.org/download/bcprov-jdk15on-156.jar\n* GSON: https://repo1.maven.org/maven2/com/google/code/gson/gson/2.6.2/gson-2.6.2.jar\n* JCE Policy Files 6: http://www.oracle.com/technetwork/java/javase/downloads/jce-6-download-429243.html\n* JCE Policy Files 7: http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html\n* JCE Policy Files 8: http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html\n\n## Compiling\n\nAll the following commands should be run from the root directory.\n\n### Compile Library\n\n```\nmkdir bin\nsh compile-lib.sh\n```\n\n### Compile \u0026 Running The Sample Application\n\n```\nsh compile-and-run-sample.sh\n```\n\n\n## Usage\n```\nResidue r = Residue.getInstance();\nr.loadConfigurations(\"config.json\");\nr.reconnect();\n\nResidue.Logger logger = Residue.getInstance().getLogger(\"default\");\n\nlogger.info(\"info log\");\nlogger.verbose(3, \"verbose level 3 log\");\n\n// you can set System.out print stream\n\nResidue.getInstance().setDefaultLoggerId(\"sample-app\");\nSystem.setOut(Residue.getInstance().getPrintStream());\n\n// all of these calls will send to residue\nSystem.out.println(\"this is %s\", \"message\");\nSystem.out.println(true);\n\n```\n\n## Samples\nCheck out [simple sample](/simple-sample) or [Android sample](/samples/android-simple/Silencer)\n\n## License\n```\nCopyright 2017-present @abumq (Majid Q.)\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabumq%2Fresidue-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabumq%2Fresidue-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabumq%2Fresidue-java/lists"}